Audience poll

GET /audiences/poll

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

Request

Query Parameters

dataCode stringrequired

Responses

Schema
Example (from schema)

Schema

status string

Possible values: [ERROR, READY, WAITING]

data

object

startDateTime date-time

The inclusive start of the period for which statistics are calculated. YYYY-MM-DDThh:mm:ss

endDateTime date-time

The exclusive end of the period for which statistics are calculated. YYYY-MM-DDThh:mm:ss

analyticsLevel string

Indicates at what level the calculations were made.

Possible values: [VISIT, VISITOR]

globalStats

object

Summed up calculations for all tracked segments

elementCount int64

Amount of tracked visits

conversions int64

Amount of tracked conversions

convertedElementCount int64

Amount of tracked converted visits

conversionRate double

How often visits are being converted. It's being calculated as convertedVisits/visits

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

averageRevenuePerElementCount double

revenue/visits

averageRevenuePerConversion double

revenue/conversions

averageConversionPerElementCount double

conversions/visits

conversionRateEvolution double

How much conversion rate for current period changed according to previous period in percents

elementCountEvolution double

How much amount of visits for current period changed according to previous period in percents

revenueEvolution double

How much amount of revenue for current period changed according to previous period in percents

averageRevenuePerElementCountEvolution double

How much revenue per visit for current period changed according to previous period in percents

averageRevenuePerConversionEvolution double

How much revenue per conversion for current period changed according to previous period in percents

segmentStats

object[]

Calculations per every segment.

Array [

segmentId int64

Identifier of the segment for which the stats was tracked

elementCount int64

Amount of tracked visits

conversions int64

Amount of tracked conversions

convertedElementCount int64

Amount of tracked converted visits

conversionRate double

How often visits are being converted. It's being calculated as convertedVisits/visits

revenue double

averageRevenuePerElementCount double

revenue/visits

averageRevenuePerConversion double

revenue/conversions

averageConversionPerElementCount double

conversions/visits

conversionRateEvolution double

How much conversion rate for current period changed according to previous period in percents

elementCountEvolution double

How much amount of visits for current period changed according to previous period in percents

revenueEvolution double

How much amount of revenue for current period changed according to previous period in percents

averageRevenuePerElementCountEvolution double

How much revenue per visit for current period changed according to previous period in percents

averageRevenuePerConversionEvolution double

How much revenue per conversion for current period changed according to previous period in percents

elementCountGapTotal double

conversionsGapTotal double

revenueGapTotal double

averageRevenuePerConversionGapTotal double

]

periodStats

object[]

Calculations separated by day interval

Array [

elementCount int64

Amount of tracked visits

conversions int64

Amount of tracked conversions

convertedElementCount int64

Amount of tracked converted visits

conversionRate double

How often visits are being converted. It's being calculated as convertedVisits/visits

revenue double

averageRevenuePerElementCount double

revenue/visits

averageRevenuePerConversion double

revenue/conversions

averageConversionPerElementCount double

conversions/visits

startDateTime date-time

endDateTime date-time

]

breakdownData

object

Filter audience by segment criteria.

usualBreakdownStats

object

property name*

object[]

Array [

breakdownName string

Identifier of the segment for which the stats was tracked

elementCount int64

Amount of tracked visits

conversions int64

Amount of tracked conversions

convertedElementCount int64

Amount of tracked converted visits

conversionRate double

How often visits are being converted. It's being calculated as convertedVisits/visits

revenue double

averageRevenuePerElementCount double

revenue/visits

averageRevenuePerConversion double

revenue/conversions

averageConversionPerElementCount double

conversions/visits

conversionRateEvolution double

How much conversion rate for current period changed according to previous period in percents

elementCountEvolution double

How much amount of visits for current period changed according to previous period in percents

revenueEvolution double

How much amount of revenue for current period changed according to previous period in percents

averageRevenuePerElementCountEvolution double

How much revenue per visit for current period changed according to previous period in percents

averageRevenuePerConversionEvolution double

How much revenue per conversion 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

revenuePart double

Proportion of the revenue of the breakdown subtype to the whole breakdown

conversionRatePart double

Proportion of the conversion rate of the breakdown subtype to the whole breakdown

revenueGapSegment double

Proportion of revenue of the breakdown to the revenue without separation by breakdown

conversionRateGapSegment double

Proportion of conversions of the breakdown to the number of conversions without separation by breakdown

]

customDataStats

object

property name*

object[]

Array [

breakdownName string

Identifier of the segment for which the stats was tracked

elementCount int64

Amount of tracked visits

conversions int64

Amount of tracked conversions

convertedElementCount int64

Amount of tracked converted visits

conversionRate double

How often visits are being converted. It's being calculated as convertedVisits/visits

revenue double

averageRevenuePerElementCount double

revenue/visits

averageRevenuePerConversion double

revenue/conversions

averageConversionPerElementCount double

conversions/visits

conversionRateEvolution double

How much conversion rate for current period changed according to previous period in percents

elementCountEvolution double

How much amount of visits for current period changed according to previous period in percents

revenueEvolution double

How much amount of revenue for current period changed according to previous period in percents

averageRevenuePerElementCountEvolution double

How much revenue per visit for current period changed according to previous period in percents

averageRevenuePerConversionEvolution double

How much revenue per conversion 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

revenuePart double

Proportion of the revenue of the breakdown subtype to the whole breakdown

conversionRatePart double

Proportion of the conversion rate of the breakdown subtype to the whole breakdown

revenueGapSegment double

Proportion of revenue of the breakdown to the revenue without separation by breakdown

conversionRateGapSegment double

Proportion of conversions of the breakdown to the number of conversions without separation by breakdown

]

errorDescription string

{
  "status": "ERROR",
  "data": {
    "startDateTime": "2024-07-29T15:51:28.071Z",
    "endDateTime": "2024-07-29T15:51:28.071Z",
    "analyticsLevel": "VISIT",
    "globalStats": {
      "elementCount": 0,
      "conversions": 0,
      "convertedElementCount": 0,
      "conversionRate": 0,
      "revenue": 0,
      "averageRevenuePerElementCount": 0,
      "averageRevenuePerConversion": 0,
      "averageConversionPerElementCount": 0,
      "conversionRateEvolution": 0,
      "elementCountEvolution": 0,
      "revenueEvolution": 0,
      "averageRevenuePerElementCountEvolution": 0,
      "averageRevenuePerConversionEvolution": 0
    },
    "segmentStats": [
      {
        "segmentId": 0,
        "elementCount": 0,
        "conversions": 0,
        "convertedElementCount": 0,
        "conversionRate": 0,
        "revenue": 0,
        "averageRevenuePerElementCount": 0,
        "averageRevenuePerConversion": 0,
        "averageConversionPerElementCount": 0,
        "conversionRateEvolution": 0,
        "elementCountEvolution": 0,
        "revenueEvolution": 0,
        "averageRevenuePerElementCountEvolution": 0,
        "averageRevenuePerConversionEvolution": 0,
        "elementCountGapTotal": 0,
        "conversionsGapTotal": 0,
        "revenueGapTotal": 0,
        "averageRevenuePerConversionGapTotal": 0
      }
    ],
    "periodStats": [
      {
        "elementCount": 0,
        "conversions": 0,
        "convertedElementCount": 0,
        "conversionRate": 0,
        "revenue": 0,
        "averageRevenuePerElementCount": 0,
        "averageRevenuePerConversion": 0,
        "averageConversionPerElementCount": 0,
        "startDateTime": "2024-07-29T15:51:28.071Z",
        "endDateTime": "2024-07-29T15:51:28.071Z"
      }
    ],
    "breakdownData": {
      "usualBreakdownStats": {},
      "customDataStats": {}
    }
  },
  "errorDescription": "string"
}

Bad Request

Schema
Example (from schema)

Schema

serviceName string

message string

{
  "serviceName": "string",
  "message": "string"
}

Internal Server Error

Schema
Example (from schema)

Schema

serviceName string

message string

{
  "serviceName": "string",
  "message": "string"
}

Audience poll

/audiences/poll

Request​

Query Parameters

Responses​

Request

Responses