Audience poll

Polling endpoint gives the data response of global and detailed requests by given datacode

Query Parameters

dataCode string required

Responses

Schema
Example (from schema)

Schema

data object
analyticsLevel string
Possible values: [VISIT, VISITOR]
Indicates at what level the calculations were made.
breakdownData object
Filter audience by segment criteria.
customDataStats object
property name* object
Array [
averageConversionPerElementCount double
conversions/visits
averageRevenuePerConversion double
revenue/conversions
averageRevenuePerConversionEvolution double
How much revenue per conversion for current period changed according to previous period in percents
averageRevenuePerElementCount double
revenue/visits
averageRevenuePerElementCountEvolution double
How much revenue per visit for current period changed according to previous period in percents
breakdownName string
Identifier of the segment for which the stats was tracked
conversionRate double
How often visits are being converted. It's being calculated as convertedVisits/visits
conversionRateEvolution double
How much conversion rate for current period changed according to previous period in percents
conversionRateGapSegment double
Proportion of conversions of the breakdown to the number of conversions without separation by breakdown
conversionRatePart double
Proportion of the conversion rate of the breakdown subtype to the whole breakdown
conversions int64
Amount of tracked conversions
convertedElementCount int64
Amount of tracked converted visits
elementCount int64
Amount of tracked visits
elementCountEvolution double
How much amount of visits for current period changed according to previous period in percents
elementCountPart double
Proportion of the number of visits of the breakdown subtype to the whole breakdown
revenue double
Amount of revenue. It can be tracked by kameleoon.js. Or it can be calculated based on audience configuration settings. If you set default amount of revenue per 1 conversion then revenue will be = conversions * the default revenue
revenueEvolution double
How much amount of revenue for current period changed according to previous period in percents
revenueGapSegment double
Proportion of revenue of the breakdown to the revenue without separation by breakdown
revenuePart double
Proportion of the revenue of the breakdown subtype to the whole breakdown
]
usualBreakdownStats object
property name* object
Array [
averageConversionPerElementCount double
conversions/visits
averageRevenuePerConversion double
revenue/conversions
averageRevenuePerConversionEvolution double
How much revenue per conversion for current period changed according to previous period in percents
averageRevenuePerElementCount double
revenue/visits
averageRevenuePerElementCountEvolution double
How much revenue per visit for current period changed according to previous period in percents
breakdownName string
Identifier of the segment for which the stats was tracked
conversionRate double
How often visits are being converted. It's being calculated as convertedVisits/visits
conversionRateEvolution double
How much conversion rate for current period changed according to previous period in percents
conversionRateGapSegment double
Proportion of conversions of the breakdown to the number of conversions without separation by breakdown
conversionRatePart double
Proportion of the conversion rate of the breakdown subtype to the whole breakdown
conversions int64
Amount of tracked conversions
convertedElementCount int64
Amount of tracked converted visits
elementCount int64
Amount of tracked visits
elementCountEvolution double
How much amount of visits for current period changed according to previous period in percents
elementCountPart double
Proportion of the number of visits of the breakdown subtype to the whole breakdown
revenue double
Amount of revenue. It can be tracked by kameleoon.js. Or it can be calculated based on audience configuration settings. If you set default amount of revenue per 1 conversion then revenue will be = conversions * the default revenue
revenueEvolution double
How much amount of revenue for current period changed according to previous period in percents
revenueGapSegment double
Proportion of revenue of the breakdown to the revenue without separation by breakdown
revenuePart double
Proportion of the revenue of the breakdown subtype to the whole breakdown
]
endDateTime date-time
The exclusive end of the period for which statistics are calculated. YYYY-MM-DDThh:mm:ss
globalStats object
Summed up calculations for all tracked segments
averageConversionPerElementCount double
conversions/visits
averageRevenuePerConversion double
revenue/conversions
averageRevenuePerConversionEvolution double
How much revenue per conversion for current period changed according to previous period in percents
averageRevenuePerElementCount double
revenue/visits
averageRevenuePerElementCountEvolution double
How much revenue per visit for current period changed according to previous period in percents
conversionRate double
How often visits are being converted. It's being calculated as convertedVisits/visits
conversionRateEvolution double
How much conversion rate for current period changed according to previous period in percents
conversions int64
Amount of tracked conversions
convertedElementCount int64
Amount of tracked converted visits
elementCount int64
Amount of tracked visits
elementCountEvolution double
How much amount of visits for current period changed according to previous period in percents
revenue double
Amount of revenue. It can be tracked by kameleoon.js. Or it can be calculated based on audience configuration settings. If you set default amount of revenue per 1 conversion then revenue will be = conversions * the default revenue
revenueEvolution double
How much amount of revenue for current period changed according to previous period in percents
periodStats object[]
Calculations separated by day interval
Array [
averageConversionPerElementCount double
conversions/visits
averageRevenuePerConversion double
revenue/conversions
averageRevenuePerElementCount double
revenue/visits
conversionRate double
How often visits are being converted. It's being calculated as convertedVisits/visits
conversions int64
Amount of tracked conversions
convertedElementCount int64
Amount of tracked converted visits
elementCount int64
Amount of tracked visits
endDateTime date-time
revenue double
Amount of revenue. It can be tracked by kameleoon.js. Or it can be calculated based on audience configuration settings. If you set default amount of revenue per 1 conversion then revenue will be = conversions * the default revenue
startDateTime date-time
]
revenueKPI object
Indicates return on investment KPI.
additionalRevenue double
conversionRate double
elementCount int64
potentialAdditionalRevenue double
revenuePerElementCount double
totalRevenue double
segmentStats object[]
Calculations per every segment.
Array [
averageConversionPerElementCount double
conversions/visits
averageRevenuePerConversion double
revenue/conversions
averageRevenuePerConversionEvolution double
How much revenue per conversion for current period changed according to previous period in percents
averageRevenuePerConversionGapTotal double
averageRevenuePerElementCount double
revenue/visits
averageRevenuePerElementCountEvolution double
How much revenue per visit for current period changed according to previous period in percents
conversionRate double
How often visits are being converted. It's being calculated as convertedVisits/visits
conversionRateEvolution double
How much conversion rate for current period changed according to previous period in percents
conversions int64
Amount of tracked conversions
conversionsGapTotal double
convertedElementCount int64
Amount of tracked converted visits
elementCount int64
Amount of tracked visits
elementCountEvolution double
How much amount of visits for current period changed according to previous period in percents
elementCountGapTotal double
revenue double
Amount of revenue. It can be tracked by kameleoon.js. Or it can be calculated based on audience configuration settings. If you set default amount of revenue per 1 conversion then revenue will be = conversions * the default revenue
revenueEvolution double
How much amount of revenue for current period changed according to previous period in percents
revenueGapTotal double
segmentId int64
Identifier of the segment for which the stats was tracked
]
startDateTime date-time
The inclusive start of the period for which statistics are calculated. YYYY-MM-DDThh:mm:ss
errorDescription string
status string
Possible values: [ERROR, READY, WAITING]

{
  "data": {
    "analyticsLevel": "VISIT",
    "breakdownData": {
      "customDataStats": {},
      "usualBreakdownStats": {}
    },
    "endDateTime": "2024-05-06T13:49:24.400Z",
    "globalStats": {
      "averageConversionPerElementCount": 0,
      "averageRevenuePerConversion": 0,
      "averageRevenuePerConversionEvolution": 0,
      "averageRevenuePerElementCount": 0,
      "averageRevenuePerElementCountEvolution": 0,
      "conversionRate": 0,
      "conversionRateEvolution": 0,
      "conversions": 0,
      "convertedElementCount": 0,
      "elementCount": 0,
      "elementCountEvolution": 0,
      "revenue": 0,
      "revenueEvolution": 0
    },
    "periodStats": [
      {
        "averageConversionPerElementCount": 0,
        "averageRevenuePerConversion": 0,
        "averageRevenuePerElementCount": 0,
        "conversionRate": 0,
        "conversions": 0,
        "convertedElementCount": 0,
        "elementCount": 0,
        "endDateTime": "2024-05-06T13:49:24.400Z",
        "revenue": 0,
        "startDateTime": "2024-05-06T13:49:24.400Z"
      }
    ],
    "revenueKPI": {
      "additionalRevenue": 0,
      "conversionRate": 0,
      "elementCount": 0,
      "potentialAdditionalRevenue": 0,
      "revenuePerElementCount": 0,
      "totalRevenue": 0
    },
    "segmentStats": [
      {
        "averageConversionPerElementCount": 0,
        "averageRevenuePerConversion": 0,
        "averageRevenuePerConversionEvolution": 0,
        "averageRevenuePerConversionGapTotal": 0,
        "averageRevenuePerElementCount": 0,
        "averageRevenuePerElementCountEvolution": 0,
        "conversionRate": 0,
        "conversionRateEvolution": 0,
        "conversions": 0,
        "conversionsGapTotal": 0,
        "convertedElementCount": 0,
        "elementCount": 0,
        "elementCountEvolution": 0,
        "elementCountGapTotal": 0,
        "revenue": 0,
        "revenueEvolution": 0,
        "revenueGapTotal": 0,
        "segmentId": 0
      }
    ],
    "startDateTime": "2024-05-06T13:49:24.400Z"
  },
  "errorDescription": "string",
  "status": "ERROR"
}

Bad Request

Schema
Example (from schema)

Schema

code string
impersonator string
message string
name string
status string
Possible values: [SUCCESS, ERROR]
sub string
time int64
timestamp date-time

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-05-06T13:49:24.401Z"
}

Forbidden

Schema
Example (from schema)

Schema

code string
impersonator string
message string
name string
status string
Possible values: [SUCCESS, ERROR]
sub string
time int64
timestamp date-time

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-05-06T13:49:24.401Z"
}

Locked

Schema
Example (from schema)

Schema

code string
impersonator string
message string
name string
status string
Possible values: [SUCCESS, ERROR]
sub string
time int64
timestamp date-time

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-05-06T13:49:24.401Z"
}

Internal Server Error

Schema
Example (from schema)

Schema

code string
impersonator string
message string
name string
status string
Possible values: [SUCCESS, ERROR]
sub string
time int64
timestamp date-time

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-05-06T13:49:24.401Z"
}

Service Unavailable

Schema
Example (from schema)

Schema

object

{}

Audience poll​

Audience poll