KAkameleoon
Audience

Get detailed audience

Get detailed statistics for one segment

get/audiences/detailed

Request

Query parameters

siteIdinteger required

Site on which audience is configured

segmentIdinteger required

Segment for which you wish to get statistics

startDatestring date required

Audience will be calculated since the date YYYY-MM-DD

endDatestring date required

Audience will be calculated till the date YYYY-MM-DD

analyticsLevel'VISIT' | 'VISITOR' required

Indicates at what level the calculations were made.

breakdownsstring[]

List of breakdowns to be displayed

{
  "startDate": "2020-07-22",
  "endDate": "2020-07-22",
  "breakdowns": [
    "[OS, BROWSER]"
  ]
}

Response

OK

dataCodestring

Hash code containing information about the data request, such as dates, goals, variations, format, filters, and so on. Use this code in the AudienceController#poll or DataController functions to obtain actual results. There are two possible formats for the code, depending on the context: 123...123 or 123...123|123...123. For example, AudienceController#global generates the latter.

Example response

{
  "dataCode": "89599333501501534304101214660291496129464311669540935471556471877530843827432"
}

Changes

No recorded changes to this operation across all 1 revision of this API.