This is the official documentation for the TWIPLA API. New endpoints will be added constantly.
Example query: /v2/visits?from=2021-09-27T00:00:00.000Z&until=2021-09-20T11:00:31.212Z&page=1&pageSize=15&order=page.asc
Time series data is useful for displaying in graphs.
Name | Type | Default | Description |
---|---|---|---|
from |
string | Today - 7 days | ISO8601 date format or YYYY-MM-DD |
until |
string | Today | ISO8601 date format or YYYY-MM-DD |
unit |
string | Based on the time interval | One of day , week , month or year |
A token can be created in two ways:
string Not applicable for 3AS | |
password | string Not applicable for 3AS |
token | string If token is sent email and password are ignored |
{- "email": "test@test.com",
- "password": "test",
- "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}
{- "token": "token-string-value",
- "refreshToken": "token-refresh-string-value",
- "userId": "user-id"
}
Get all website visits with filters
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter (default = until - 7 days) |
until | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter (default = today's date) |
previousFrom | string <date-time> (ISO8601) Example: previousFrom=2018-01-01T00:00:00.000Z Lower bound date filter; optional |
previousUntil | string <date-time> (ISO8601) Example: previousUntil=2022-04-18T22:59:59.000Z Upper bound date filter; optional |
group | string Example: group=page (only group by page option available) Property by which to group the response |
order | string Enum: "desc" "asc" Example: order=count.asc|desc (only count ordering option) Orders the results from query ascending or descending. |
page | integer Example: page=1 Page to be requested |
pageSize | integer Example: pageSize=20 Number of items per page to be requested; maximum number of elements per page is 500 if group=null |
{- "payload": [
- {
- "unixTs": 1529230033,
- "websiteKey": "2dc02576-f22f-11ec-b772-0242ac120004",
- "sessionKey": "5b2632d211d969.77370315",
- "pageKey": "08d024a29cfae918ee1245e3c9df86c6",
}, - {
- "unixTs": 1529230077,
- "websiteKey": "2dc02576-f22f-11ec-b772-0242ac120004",
- "sessionKey": "5b2632d211d969.77370915",
- "pageKey": "08d024a29cfae918ee1245e3c9df86c6",
}
]
}
Get visits information as graph data
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
type | string Value: "time-series" Example: type=time-series |
unit | string Enum: "day" "week" "month" "year" Example: unit=day |
{- "payload": {
- "datasets": [
- {
- "label": "Overall Page Visits",
- "data": [
- 32,
- 50,
- 80
]
}
], - "labels": [
- "2022-06-22T15:46:47Z"
]
}
}
Get all website visits from the current month considering timezone
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "payload": {
- "count": 1
}
}
Get all website visits given a period considering timezone
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
period required | string Enum: "daily" "monthly" "hourly" Period of the results from query. |
specificYear | string Specific year of the results from query. |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
[- {
- "title": "12",
- "count": 1
}, - {
- "title": "13",
- "count": 2
}
]
Get all website visits within a specified time range and organizes them by day. Also calculates the count of visits for a previous period with the same duration. The results are sorted by day and consider the specified timezone for the data
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}
Get website visits withing a specified time range, filtering by page URL. Calculate the counts of visits for both current and previous time period, organize the results by page and include page titles. Consider timezone for data processing.
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
length | integer Length of the results from query. |
pageUrl required | string Page URL of the results from query. |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "pages": [
- {
- "title": "Page title",
- "count": 10,
- "id": "ccfa9327-ddc4-43dc-9d5f-b1828fafe23f",
- "isDeleted": false,
- "suffix": "/page"
}
], - "total": {
- "current": 10,
- "previous": 20,
- "totalPages": 2
},
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z from date, default is 7 days ago |
until | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z until date, default is today |
page | integer Example: page=1 page number, default is 1 |
pageSize | integer Example: pageSize=20 page size, default is 10 |
unit | string Enum: "day" "week" "month" "year" Example: unit=day |
Array of objects Example: order=visits.desc,companyOrgName.asc order by, default is | |
companyOrgName | string Example: companyOrgName=Orange Company name, default returns all companies. Partial values accepted |
{- "payload": [
- {
- "companyOrgName": "Orange",
- "companyOrgType": "Telecom",
- "visits": 12,
- "visitsPercentage": 0.23
}
], - "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}
}
Count and organize visit data by timestamp, grouping it into time period defined by unit
. It fills in missing data points with 0.
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
onlyTotal | boolean Whether to include only total in the results from query. |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "total": 4
}
Get count for competition website visits within a specified time range for a given country code and business sector.
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
businessSector required | integer Business sector of the results from query. |
countryCode required | string Example: countryCode=US | BR | DE | GB | RO Country code of the results from query. Length must be 2. |
{- "total": 4
}
Get all website visitors with filters
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
previousFrom | string <date-time> (ISO8601) Example: previousFrom=2018-01-01T00:00:00.000Z Lower bound date filter; optional |
previousUntil | string <date-time> (ISO8601) Example: previousUntil=2022-04-18T22:59:59.000Z Upper bound date filter; optional |
group | string Enum: "device" "display" "browser" "operatingSystem" Groups the results by filter. If other string or none is sent, by default the result is grouped by |
order | string Enum: "desc" "asc" Example: order=count.asc|desc or by group name: device.desc|asc, browser.desc|asc, display.desc|asc, operatingSystem.desc|asc Orders the results from query ascending or descending. |
page | integer Example: page=1 Page to be requested |
pageSize | integer Example: pageSize=20 Number of items per page to be requested |
{- "payload": [
- {
- "device|display|browser|operatingSystem": "string",
- "count": 7,
- "previousCount": 7
}
], - "meta": {
- "page": 1,
- "pageSize": 20,
- "total": 3,
- "visitorsTotal": 9,
- "previousvisitorsTotal": 9
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
type required | string Enum: "time-series" "pie" "bar" Example: type=time-series |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "payload": {
- "labels": [
- "string"
], - "datasets": [
- {
- "label": "string",
- "data": [
- 0
]
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
type required | string Enum: "time-series" "pie" "bar" Example: type=time-series |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "payload": {
- "labels": [
- "string"
], - "datasets": [
- {
- "label": "string",
- "data": [
- 0
]
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
type required | string Enum: "time-series" "pie" "bar" Example: type=time-series |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "payload": {
- "labels": [
- "string"
], - "datasets": [
- {
- "label": "string",
- "data": [
- 0
]
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
type required | string Enum: "time-series" "pie" "bar" Example: type=time-series |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "payload": {
- "labels": [
- "string"
], - "datasets": [
- {
- "label": "string",
- "data": [
- 0
]
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
type required | string Enum: "time-series" "pie" "bar" Example: type=time-series |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "payload": {
- "labels": [
- "string"
], - "datasets": [
- {
- "label": "string",
- "data": [
- 0
]
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
type required | string Enum: "time-series" "pie" "bar" Example: type=time-series |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "payload": {
- "labels": [
- "string"
], - "datasets": [
- {
- "label": "string",
- "data": [
- 0
]
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
[- {
- "sessionKey": "string",
- "position": [
- 0
], - "isPrivate": true
}
]
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
start required | integer Example: start=6 page |
length required | integer Length of the results from query. |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "visitsTotal": 0,
- "data": [
- {
- "page": {
- "url": "string",
- "title": "string"
}, - "unixTs": 0,
- "device": "string",
- "platform": "string",
- "browser": "string",
- "countryCode": "string",
- "status": 0,
- "ip": "string",
- "pagesCount": 0,
- "sessionDuration": 0
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
aggr required | string Example: by-country | by-city aggregate by country or city, default is by country |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
start required | integer Example: start=6 page |
length required | integer Length of the results from query. |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
[- {
- "name": "New York",
- "countryCode": "US",
- "count": 123
}, - {
- "name": "London",
- "countryCode": "GB",
- "count": 456
}
]
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "count": 0,
- "visitors": [
- {
- "visitorKey": "string",
- "lastVisitTs": 0,
- "latitude": 0,
- "longitude": 0,
- "ip": "string",
- "countryCode": "string",
- "deviceType": "string",
- "browserName": "string",
- "platform": "string",
- "visitorType": 0,
- "visitDetails": "string"
}
]
}
Get count for competition website visitors within a specified time range for a given country code and business sector.
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
businessSector required | integer Business sector of the results from query. |
countryCode required | string Example: countryCode=US | BR | DE | GB | RO Country code of the results from query. Length must be 2. |
{- "total": 4
}
Get count for unique competition website visitors within a specified time range for a given country code and business sector.
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
businessSector required | integer Business sector of the results from query. |
countryCode required | string Example: countryCode=US | BR | DE | GB | RO Country code of the results from query. Length must be 2. |
{- "total": 4
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
pageUrl required | string Page URL of the results from query. |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
[- {
- "domPath": "string",
- "domPathKey": "string",
- "actions": [
- {
- "name": "string",
- "devices": {
- "desktop": 0,
- "mobile": 0,
- "phone": 0
}
}
]
}
]
Get count for competition website visits within a specified time range for a given country code and business sector.
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
businessSector required | integer Business sector of the results from query. |
countryCode required | string Example: countryCode=US | BR | DE | GB | RO Country code of the results from query. Length must be 2. |
{- "total": 4
}
Get count for competition website visitors within a specified time range for a given country code and business sector.
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
businessSector required | integer Business sector of the results from query. |
countryCode required | string Example: countryCode=US | BR | DE | GB | RO Country code of the results from query. Length must be 2. |
{- "total": 4
}
Get count for unique competition website visitors within a specified time range for a given country code and business sector.
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
businessSector required | integer Business sector of the results from query. |
countryCode required | string Example: countryCode=US | BR | DE | GB | RO Country code of the results from query. Length must be 2. |
{- "total": 4
}
Get count for unique competition website visitors within a specified time range for a given country code and business sector.
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
businessSector required | integer Business sector of the results from query. |
countryCode required | string Example: countryCode=US | BR | DE | GB | RO Country code of the results from query. Length must be 2. |
browsers | Array of strings |
{- "browsers": [
- "Chrome",
- "Firefox",
- "Safari",
- "Opera"
]
}
[- [
- "Chrome",
- 45.12
], - [
- "Firefox",
- 32.56
], - [
- "Safari",
- 52.77
]
]
Get count for unique competition visits by OS within a specified time range for a given country code and business sector.
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
businessSector required | integer Business sector of the results from query. |
countryCode required | string Example: countryCode=US | BR | DE | GB | RO Country code of the results from query. Length must be 2. |
operatingSystems | Array of strings |
{- "operatingSystems": [
- "Windows",
- "Mac OS",
- "Linux",
- "Android",
- "iOS"
]
}
[- [
- "Linux",
- 45.12
], - [
- "Windows",
- 32.56
], - [
- "iOS",
- 52.77
]
]
Get count for unique competition visits by device within a specified time range for a given country code and business sector.
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
businessSector required | integer Business sector of the results from query. |
countryCode required | string Example: countryCode=US | BR | DE | GB | RO Country code of the results from query. Length must be 2. |
devices | Array of strings |
{- "devices": [
- "Desktop",
- "Mobile",
- "Tablet"
]
}
[- [
- "Desktop",
- 45.12
], - [
- "Mobile",
- 32.56
], - [
- "Tablet",
- 52.77
]
]
Get count for unique competition visits by screen size within a specified time range for a given country code and business sector.
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
businessSector required | integer Business sector of the results from query. |
countryCode required | string Example: countryCode=US | BR | DE | GB | RO Country code of the results from query. Length must be 2. |
screenSizes | Array of strings |
{- "screenSizes": [
- "0-320",
- "321-480",
- "481-768",
- "769-1024"
]
}
[- [
- "0-320",
- 45.12
], - [
- "321-480",
- 32.56
], - [
- "769-1024",
- 52.77
]
]
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter (default = until - 7 days) |
until | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter (default = today's date) |
previousFrom | string <date-time> (ISO8601) Example: previousFrom=2018-01-01T00:00:00.000Z Lower bound date filter; optional |
previousUntil | string <date-time> (ISO8601) Example: previousUntil=2022-04-18T22:59:59.000Z Upper bound date filter; optional |
group | string Enum: "country" "landing-page" "page" "referrer" Example: group=country Groups the results by filter. No default option is available. |
order | string Enum: "desc" "asc" Example: order=count.asc,referrer.desc (only for group by referrer) Orders the results from query ascending or descending. |
pageSize | integer Example: pageSize=20 Number of items per page to be requested; maximum number of elements per page is 500 if group=null |
page | integer Example: page=1 Page to be requested |
{- "payload": [
- {
- "sessionKey": "session-key-string",
- "websiteKey": "website-key-string",
- "visitorKey": "visitor-key-string",
- "lastVisitTs": 1656927734,
- "createdAt": 1651927731,
- "totalVisits": null,
- "location": {
- "latitude": null,
- "longitude": null
}, - "referrerUrl": null,
- "ip": "ip-string",
- "countryCode": "RO",
- "display": null,
- "platform": "linux",
- "browserName": "Firefox",
- "browserVersion": "101.0",
- "deviceType": "desktop"
}
], - "meta": {
- "page": 1,
- "pageSize": 20,
- "sessionsTotal": 1
}
}
Get sessions information as graph data
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
type required | string Enum: "time-series" "pie" "bar" Example: type=time-series |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "payload": {
- "labels": [
- "string"
], - "datasets": [
- {
- "label": "string",
- "data": [
- 0
]
}
]
}
}
Get sessions information as graph data
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
type required | string Enum: "time-series" "pie" "bar" Example: type=time-series |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "payload": {
- "labels": [
- "string"
], - "datasets": [
- {
- "label": "string",
- "data": [
- 0
]
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
containsPage | string |
notContainsPage | string |
object | |
devices | Array of strings |
object | |
object | |
status | Array of integers |
{- "containsPage": "string",
- "notContainsPage": "string",
- "country": {
- "is": "string",
- "isNot": "string"
}, - "devices": [
- "string"
], - "os": {
- "is": "string",
- "isNot": "string"
}, - "browser": {
- "is": "string",
- "isNot": "string"
}, - "status": [
- 0
]
}
{- "sessionsTotal": 0,
- "data": [
- {
- "id": "string",
- "visitorKey": "string",
- "pageVisitsInSession": 0,
- "device": "string",
- "platform": "string",
- "browser": "string",
- "countryCode": "string",
- "location": {
- "lat": 0,
- "lng": 0
}, - "status": 0,
- "ip": "string",
- "companyOrgName": "string",
- "companyOrgType": "string",
- "hasRecording": true,
- "duration": 0,
- "sessionExtras": {
- "id": "string",
- "seen": true,
- "star": true,
- "tags": [
- "string"
]
}, - "visitorStatus": 0,
- "adCampaignSource": "string",
- "adCampaignMedium": "string",
- "adCampaignTerm": "string",
- "adCampaignKey": "string",
- "adCampaignLabel": "string",
- "pageVisit": {
- "key": "string",
- "url": "string",
- "title": "string",
- "unixTs": 0
}, - "lastVisitTs": 0
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
sessionId required | string Example: sessionId=5f7b1b2b-5b0b-4b0b-8b0b-5b0b1b2b5b0b Session ID |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "data": {
- "ip": "string",
- "device": "string",
- "platform": "string",
- "browser": "string",
- "display": "string",
- "countryCode": "string",
- "location": {
- "lat": 0,
- "lng": 0
}, - "sessions": [
- {
- "id": "string",
- "status": 0,
- "sessionsStart": 0,
- "ip": "string",
- "countryCode": "string",
- "location": {
- "lat": 0,
- "lng": 0
}, - "adCampaignSource": "string",
- "adCampaignMedium": "string",
- "adCampaignTerm": "string",
- "adCampaignKey": "string",
- "adCampaignLabel": "string",
- "adCampaignContent": "string",
- "referrer": "string",
- "hasRecording": true,
- "duration": 0,
- "pageVisits": [
- {
- "key": "string",
- "url": "string",
- "title": "string",
- "unixTs": 0
}
], - "sessionExtras": {
- "id": "string",
- "seen": true,
- "star": true,
- "tags": [
- "string"
]
}
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
limit | integer Limit number of sessions to return. Default is 6 |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "sessionsTotal": 0,
- "data": [
- {
- "id": "string",
- "visitorKey": "string",
- "pageVisitsInSession": 0,
- "device": "string",
- "platform": "string",
- "browser": "string",
- "display": "string",
- "sessionStart": 0,
- "status": 0,
- "ip": "string",
- "countryCode": "string",
- "location": {
- "lat": 0,
- "lng": 0
}, - "companyOrgName": "string",
- "companyOrgType": "string",
- "referrer": "string",
- "hasRecording": true,
- "duration": 0,
- "pageVisit": {
- "key": "string",
- "url": "string",
- "title": "string",
- "unixTs": 0
}, - "sessionExtras": {
- "id": "string",
- "seen": true,
- "star": true,
- "tags": [
- "string"
]
}, - "visitorStatus": 0
}
]
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
heatmapId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a heatmap |
group | string Example: group=country Groups the results by filter. Only group by country option available |
order | string Enum: "desc" "asc" Example: order=count.asc|desc or country.desc|asc Orders the results from query ascending or descending. |
pageSize | integer Example: pageSize=20 Number of items per page to be requested |
page | integer Example: page=1 Page to be requested |
{- "payload": [
- {
- "country": "RO",
- "count": 10
}, - {
- "country": "US",
- "count": 2
}
], - "meta": {
- "page": 1,
- "pageSize": 20,
- "total": 2,
- "sessionsTotal": 12
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "payload": {
- "average-duration": 0
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
starred | string |
watched | string |
from | number <int64> |
until | number <int64> |
object | |
object | |
object | |
devices | Array of strings |
status | Array of integers |
containsPage | string |
notContainsPage | string |
object | |
object | |
entryPage | string |
exitPage | string |
object | |
referrerURLs | Array of strings |
trafficChannels | Array of strings |
adCampaignLabels | Array of strings |
{- "starred": "string",
- "watched": "string",
- "from": 0,
- "until": 0,
- "country": {
- "is": "string",
- "isNot": "string"
}, - "os": {
- "is": "string",
- "isNot": "string"
}, - "browser": {
- "is": "string",
- "isNot": "string"
}, - "devices": [
- "string"
], - "status": [
- 0
], - "containsPage": "string",
- "notContainsPage": "string",
- "durations": {
- "min": 0,
- "max": 0
}, - "pageCount": {
- "min": 0,
- "max": 0
}, - "entryPage": "string",
- "exitPage": "string",
- "funnelDropouts": {
- "id": "string",
- "level": 0
}, - "referrerURLs": [
- "string"
], - "trafficChannels": [
- "string"
], - "adCampaignLabels": [
- "string"
]
}
{- "sessionsTotal": 0,
- "data": [
- {
- "id": "string",
- "status": 0,
- "countryCode": "string",
- "sessionStart": 0,
- "referrer": "string",
- "platform": "string",
- "device": "string",
- "browser": "string",
- "screenSize": "string",
- "location": {
- "lat": 0,
- "lng": 0
}, - "visitorId": "string",
- "entryPage": "string",
- "exitPage": "string",
- "ssrStatus": 0,
- "ssrInfo": {
- "pagesCount": 0,
- "duration": 0,
- "pages": [
- {
- "url": "string",
- "duration": 0,
- "timestamp": 0,
- "type": 0
}
]
}, - "sessionExtras": {
- "id": "string",
- "seen": true,
- "star": true,
- "tags": [
- "string"
]
}, - "comment": "string"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
starred | string |
watched | string |
from | number <int64> |
until | number <int64> |
object | |
object | |
object | |
devices | Array of strings |
status | Array of integers |
containsPage | string |
notContainsPage | string |
object | |
object | |
entryPage | string |
exitPage | string |
object | |
referrerURLs | Array of strings |
trafficChannels | Array of strings |
adCampaignLabels | Array of strings |
object |
{- "starred": "string",
- "watched": "string",
- "from": 0,
- "until": 0,
- "country": {
- "is": "string",
- "isNot": "string"
}, - "os": {
- "is": "string",
- "isNot": "string"
}, - "browser": {
- "is": "string",
- "isNot": "string"
}, - "devices": [
- "string"
], - "status": [
- 0
], - "containsPage": "string",
- "notContainsPage": "string",
- "durations": {
- "min": 0,
- "max": 0
}, - "pageCount": {
- "min": 0,
- "max": 0
}, - "entryPage": "string",
- "exitPage": "string",
- "funnelDropouts": {
- "id": "string",
- "level": 0
}, - "referrerURLs": [
- "string"
], - "trafficChannels": [
- "string"
], - "adCampaignLabels": [
- "string"
], - "tags": {
- "property1": "string",
- "property2": "string"
}
}
{- "sessionsTotal": 0,
- "data": [
- {
- "id": "string",
- "status": 0,
- "countryCode": "string",
- "sessionStart": 0,
- "referrer": "string",
- "platform": "string",
- "device": "string",
- "browser": "string",
- "screenSize": "string",
- "location": {
- "lat": 0,
- "lng": 0
}, - "visitorId": "string",
- "entryPage": "string",
- "exitPage": "string",
- "ssrStatus": 0,
- "ssrInfo": {
- "pagesCount": 0,
- "duration": 0,
- "pages": [
- {
- "url": "string",
- "duration": 0,
- "timestamp": 0,
- "type": 0
}
]
}, - "sessionExtras": {
- "id": "string",
- "seen": true,
- "star": true,
- "tags": [
- "string"
]
}, - "comment": "string",
- "tags": {
- "property1": "string",
- "property2": "string"
}
}
]
}
The SQL queries in the code retrieve and analyze data from a database to understand how people visit a website. They count and categorize the traffic sources, helping website owners to see where their visitors are coming from and how they interact with the site.
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
{- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z",
- "points": [
- {
- "channelType": 0,
- "values": [
- {
- "company": "string",
- "value": 0
}
]
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "overall": 0,
- "points": [
- {
- "channelType": 0,
- "value": 0
}
], - "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "overall": 0,
- "points": [
- {
- "channelType": 0,
- "value": 0
}
], - "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "overall": 0,
- "points": [
- {
- "channelType": 0,
- "value": 0
}
], - "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "overall": 0,
- "points": [
- {
- "channelType": 0,
- "value": 0
}
], - "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
null
{- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "overall": 0,
- "points": [
- {
- "channelType": 0,
- "value": 0
}
], - "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "overall": 0,
- "points": [
- {
- "channelType": 0,
- "value": 0
}
], - "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "current": [
- {
- "points": [
- {
- "channelType": 1,
- "values": [
- {
- "company": "Google",
- "value": 10
}
]
}
], - "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 10,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "points": [
- {
- "channelType": 1,
- "values": [
- {
- "company": "Google",
- "value": 10
}
]
}
], - "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 10,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "current": [
- {
- "points": [
- {
- "channelType": 1,
- "values": [
- {
- "company": "Google",
- "value": 10
}
]
}
], - "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 10,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "points": [
- {
- "channelType": 1,
- "values": [
- {
- "company": "Google",
- "value": 10
}
]
}
], - "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 10,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "current": [
- {
- "points": [
- {
- "channelType": 0,
- "values": [
- {
- "company": "string",
- "value": 0
}
]
}
], - "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}
], - "previous": [
- {
- "points": [
- {
- "channelType": 0,
- "values": [
- {
- "company": "string",
- "value": 0
}
]
}
], - "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "current": [
- {
- "points": [
- {
- "channelType": 0,
- "values": [
- {
- "company": "string",
- "value": 0
}
]
}
], - "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}
], - "previous": [
- {
- "points": [
- {
- "channelType": 0,
- "values": [
- {
- "company": "string",
- "value": 0
}
]
}
], - "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "page": 0,
- "pageSize": 0,
- "totalPages": 0,
- "totalItems": 0,
- "items": [
- {
- "pageUrl": "string",
- "visitors": 0,
- "newVisitors": 0,
- "returningVisitors": 0,
- "topReferer": "string",
- "topRefererVisits": 0,
- "topRefererAverageDuration": 0,
- "visits": 0,
- "averageDuration": 0,
- "segments": [
- {
- "id": "string",
- "data": {
- "pageUrl": "string",
- "visitors": 0,
- "newVisitors": 0,
- "returningVisitors": 0,
- "topReferer": "string",
- "topRefererVisits": 0,
- "topRefererAverageDuration": 0,
- "visits": 0,
- "averageDuration": 0
}
}
]
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
true
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "totalCurrent": 200,
- "totalPrevious": 199,
- "current": [
- {
- "value": 100,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 100,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 101,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 98,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "totalCurrent": 200,
- "totalPrevious": 199,
- "current": [
- {
- "value": 100,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 100,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 101,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 98,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "totalCurrent": 200,
- "totalPrevious": 199,
- "current": [
- {
- "value": 100,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 100,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 101,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 98,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "totalCurrent": 200,
- "totalPrevious": 199,
- "current": [
- {
- "value": 100,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 100,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 101,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 98,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "totalCurrent": 200,
- "totalPrevious": 199,
- "current": [
- {
- "value": 100,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 100,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 101,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 98,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "totalCurrent": 200,
- "totalPrevious": 199,
- "current": [
- {
- "value": 100,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 100,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 101,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 98,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "totalCurrent": 200,
- "totalPrevious": 199,
- "current": [
- {
- "value": 100,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 100,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 101,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 98,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "totalCurrent": 200,
- "totalPrevious": 199,
- "current": [
- {
- "value": 100,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 100,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 101,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 98,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "totalCurrent": 199.99,
- "totalPrevious": 199.99,
- "current": [
- {
- "value": 100,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 99.99,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 99.9,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 100.09,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "totalCurrent": 199.99,
- "totalPrevious": 199.99,
- "current": [
- {
- "value": 100,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 99.99,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 99.9,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 100.09,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "totalCurrent": 199.99,
- "totalPrevious": 199.99,
- "current": [
- {
- "value": 100,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 99.99,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 99.9,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 100.09,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "totalCurrent": 199.99,
- "totalPrevious": 199.99,
- "current": [
- {
- "value": 100,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 99.99,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 99.9,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 100.09,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "totalCurrent": 199.99,
- "totalPrevious": 199.99,
- "current": [
- {
- "value": 100,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 99.99,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 99.9,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 100.09,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "totalCurrent": 199.99,
- "totalPrevious": 199.99,
- "current": [
- {
- "value": 100,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 99.99,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 99.9,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 100.09,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "totalCurrent": 199.99,
- "totalPrevious": 199.99,
- "current": [
- {
- "value": 100,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 99.99,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 99.9,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 100.09,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "totalCurrent": 199.99,
- "totalPrevious": 199.99,
- "current": [
- {
- "value": 100,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 99.99,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 99.9,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 100.09,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "current": 79.12,
- "previous": 79.12
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "current": 79.12,
- "previous": 79.12
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "current": 79.12,
- "previous": 79.12
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "current": 79.12,
- "previous": 79.12
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "current": 79.12,
- "currentInfo": "string",
- "previous": 79.12,
- "previousInfo": "string"
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "current": 79.12,
- "currentInfo": "string",
- "previous": 79.12,
- "previousInfo": "string"
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "current": 79.12,
- "currentInfo": "string",
- "previous": 79.12,
- "previousInfo": "string"
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "current": 79.12,
- "currentInfo": "string",
- "previous": 79.12,
- "previousInfo": "string"
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
limit required | integer Example: limit=10 limit |
start required | integer Example: start=6 page |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "count": 2,
- "total": 2,
- "items": [
- {
- "name": "Product 1",
- "variant": "Variant 1",
- "current": 2,
- "previous": 2
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
limit required | integer Example: limit=10 limit |
start required | integer Example: start=6 page |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "count": 2,
- "total": 2,
- "items": [
- {
- "name": "Product 1",
- "variant": "Variant 1",
- "current": 2,
- "previous": 2
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
limit required | integer Example: limit=10 limit |
start required | integer Example: start=6 page |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "count": 2,
- "total": 2,
- "items": [
- {
- "name": "Product 1",
- "variant": "Variant 1",
- "current": 2,
- "previous": 2
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
limit required | integer Example: limit=10 limit |
start required | integer Example: start=6 page |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "count": 2,
- "total": 2,
- "items": [
- {
- "name": "Product 1",
- "variant": "Variant 1",
- "current": 2,
- "previous": 2
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
limit required | integer Example: limit=10 limit |
start required | integer Example: start=6 page |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "count": 2,
- "total": 2,
- "items": [
- {
- "name": "Product 1",
- "variant": "Variant 1",
- "current": 2,
- "previous": 2
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
limit required | integer Example: limit=10 limit |
start required | integer Example: start=6 page |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "count": 2,
- "total": 2,
- "items": [
- {
- "name": "Product 1",
- "variant": "Variant 1",
- "current": 2,
- "previous": 2
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
limit required | integer Example: limit=10 limit |
start required | integer Example: start=6 page |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "count": 2,
- "total": 2,
- "items": [
- {
- "name": "Product 1",
- "variant": "Variant 1",
- "current": 2,
- "previous": 2
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
limit required | integer Example: limit=10 limit |
start required | integer Example: start=6 page |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "count": 2,
- "total": 2,
- "items": [
- {
- "name": "Product 1",
- "variant": "Variant 1",
- "current": 2,
- "previous": 2
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
limit required | integer Example: limit=10 limit |
start required | integer Example: start=6 page |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
[- {
- "name": "John Doe",
- "email": "john.doe@gmail.com",
- "phoneNumber": "+1 123 456 7890",
- "revenue": 198.12,
- "products": 2,
- "orders": 2,
- "latestOrder": "2020-01-01T00:00:00Z"
}
]
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
limit required | integer Example: limit=10 limit |
start required | integer Example: start=6 page |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
[- {
- "id": "uuid",
- "customerName": "John Doe",
- "type": 1,
- "trafficChannel": "Organic",
- "trafficChannelSpecific": "Go",
- "UTMCampaignKey": "utm_campaign",
- "UTMSource": "utm_source",
- "UTMMedium": "utm_medium",
- "UTMTerm": "utm_term",
- "UTMContent": "utm_content",
- "UTMLabel": "utm_label",
- "UTMSourcePlatform": "utm_source_platform",
- "UTMCreativeFormat": "utm_creative_format",
- "UTMMarketingTactic": "utm_marketing_tactic",
- "orderDate": "2020-01-01T00:00:00Z",
- "value": 198.12,
- "productCount": 2
}
]
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
limit required | integer Example: limit=10 limit |
start required | integer Example: start=6 page |
order required | string Permited values: name, grossRevenue, orderCount Example: name.asc, grossRevenue.desc Default is name.asc |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "count": 1,
- "countOrders": 1,
- "grossRevenue": 100.12,
- "payload": [
- {
- "id": "uuid",
- "originalID": "uuid",
- "name": "John Doe",
- "email": "jd@gmail.com",
- "phoneNumber": "123456789",
- "grossRevenue": 100.12,
- "orderCount": 1
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
limit required | integer Example: limit=10 limit |
start required | integer Example: start=6 page |
itemName | string Example: "Product 1" Default is "Product 1" |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
[- {
- "id": "uuid",
- "name": "Product 1"
}
]
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
limit required | integer Example: limit=10 limit |
start required | integer Example: start=6 page |
itemName | string Example: "Product 1" Default is "Product 1" |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
[- {
- "id": "uuid",
- "name": "Product 1"
}
]
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
items | integer Example: items=10 items |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
[- {
- "itemId": "uuid",
- "itemName": "Product 1",
- "payload": {
- "totalCurrent": 22.22,
- "totalPrevious": 22.22,
- "current": [
- {
- "value": 0,
- "from": "string",
- "until": "string"
}
], - "previous": [
- {
- "value": 0,
- "from": "string",
- "until": "string"
}
]
}
}
]
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
items | integer Example: items=10 items |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
[- {
- "itemId": "uuid",
- "itemName": "Product 1",
- "payload": {
- "totalCurrent": 22.22,
- "totalPrevious": 22.22,
- "current": [
- {
- "value": 0,
- "from": "string",
- "until": "string"
}
], - "previous": [
- {
- "value": 0,
- "from": "string",
- "until": "string"
}
]
}
}
]
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
items | integer Example: items=10 items |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
[- {
- "itemId": "uuid",
- "itemName": "Product 1",
- "payload": {
- "totalCurrent": 22,
- "totalPrevious": 22,
- "current": [
- {
- "value": 0,
- "from": "string",
- "until": "string"
}
], - "previous": [
- {
- "value": 0,
- "from": "string",
- "until": "string"
}
]
}
}
]
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
items | integer Example: items=10 items |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
[- {
- "itemId": "uuid",
- "itemName": "Product 1",
- "payload": {
- "totalCurrent": 22,
- "totalPrevious": 22,
- "current": [
- {
- "value": 0,
- "from": "string",
- "until": "string"
}
], - "previous": [
- {
- "value": 0,
- "from": "string",
- "until": "string"
}
]
}
}
]
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
limit required | integer Example: limit=10 limit |
start required | integer Example: start=6 page |
order required | string Permited values: itemName, cntSold, sku, cateogry, price, numViews, addToWishlist, addToCart, removeFromCart Example: itemName.asc Default is cntSold.desc |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "count": 1,
- "payload": [
- {
- "id": "uuid",
- "name": "John Doe",
- "category": "Category",
- "soldItems": 2,
- "countViews": 2,
- "countAddToWishlist": 2,
- "countAddToCart": 2,
- "countRemoveFromCart": 2,
- "price": 198.12
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
limit required | integer Example: limit=10 limit |
start required | integer Example: start=6 page |
order required | string Permited values: itemName, cntSold, sku, cateogry, price, numViews, addToWishlist, addToCart, removeFromCart Example: itemName.asc Default is cntSold.desc |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "count": 1,
- "payload": [
- {
- "id": "uuid",
- "name": "John Doe",
- "category": "Category",
- "soldItems": 2,
- "countViews": 2,
- "countAddToWishlist": 2,
- "countAddToCart": 2,
- "countRemoveFromCart": 2,
- "price": 198.12
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
limit | integer Example: limit=10 limit |
start | integer Example: start=6 page |
order | string Permited values: itemName, numViews Example: itemName.asc Default is numViews.desc |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "count": 1,
- "payload": [
- {
- "viewCount": 2,
- "name": "Product 1"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
limit | integer Example: limit=10 limit |
start | integer Example: start=6 page |
order | string Permited values: itemName, numViews Example: itemName.asc Default is numViews.desc |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "count": 1,
- "payload": [
- {
- "viewCount": 2,
- "name": "Product 1"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "totalCurrent": 20,
- "totalPrevious": 20,
- "current": [
- {
- "value": 10,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 10,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 5,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 15,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "totalCurrent": 20,
- "totalPrevious": 20,
- "current": [
- {
- "value": 10,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 10,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 5,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 15,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "totalCurrent": 20,
- "totalPrevious": 20,
- "current": [
- {
- "value": 10,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 10,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 5,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 15,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "totalCurrent": 20,
- "totalPrevious": 20,
- "current": [
- {
- "value": 10,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 10,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 5,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 15,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "current": [
- {
- "points": [
- {
- "channelType": 1,
- "values": [
- {
- "company": "Google",
- "value": 10
}
]
}
], - "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 10,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "points": [
- {
- "channelType": 1,
- "values": [
- {
- "company": "Google",
- "value": 10
}
]
}
], - "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 10,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "current": [
- {
- "points": [
- {
- "channelType": 1,
- "values": [
- {
- "company": "Google",
- "value": 10
}
]
}
], - "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 10,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "points": [
- {
- "channelType": 1,
- "values": [
- {
- "company": "Google",
- "value": 10
}
]
}
], - "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 10,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "current": [
- {
- "points": [
- {
- "channelType": 0,
- "values": [
- {
- "company": "string",
- "value": 0
}
]
}
], - "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}
], - "previous": [
- {
- "points": [
- {
- "channelType": 0,
- "values": [
- {
- "company": "string",
- "value": 0
}
]
}
], - "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "current": [
- {
- "points": [
- {
- "channelType": 0,
- "values": [
- {
- "company": "string",
- "value": 0
}
]
}
], - "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}
], - "previous": [
- {
- "points": [
- {
- "channelType": 0,
- "values": [
- {
- "company": "string",
- "value": 0
}
]
}
], - "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
limit required | integer Example: limit=10 limit |
start required | integer Example: start=6 page |
order | string Permited values: name, customerId, phoneNumber, cartValue, abandonment, numProducts Example: name.desc Default is abandonment.desc |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "count": 1,
- "payload": [
- {
- "customerName": "John Doe",
- "customerEmail": "johndoe@mail.com",
- "customerPhoneNumber": "+1 123 456 7890",
- "customerId": "1234567890",
- "cartValue": 123.45,
- "abandonment": 0,
- "dateTimeAbandonment": "2020-01-01T00:00:00Z",
- "products": [
]
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
limit required | integer Example: limit=10 limit |
start required | integer Example: start=6 page |
order | string Permited values: name, customerId, phoneNumber, cartValue, abandonment, numProducts Example: name.desc Default is abandonment.desc |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "count": 1,
- "payload": [
- {
- "customerName": "John Doe",
- "customerEmail": "johndoe@mail.com",
- "customerPhoneNumber": "+1 123 456 7890",
- "customerId": "1234567890",
- "cartValue": 123.45,
- "abandonment": 0,
- "dateTimeAbandonment": "2020-01-01T00:00:00Z",
- "products": [
]
}
]
}
Some resources support retrieving data in graph form. There are several types of graphs available: time-series
, pie
or bar
. They all have the same response body:
{
"payload": {
"labels": ["2021-09-27T00:00:00.000Z", "2021-09-28T00:00:00.000Z"],
"datasets": [
{
"label": "Dataset 1",
"data": [20, 30]
}
]
}
}
Examples
/v2/traffic-structure/graph?type=time-series&unit=week
/v2/traffic-structure/graph?type=pie
/v2/traffic-structure/graph?type=bar
Most graph endpoints support Time-Filtering. Most time series endpoints also support Time Units for time bucketing.
Time series graph data is aggregated into time buckets using time units. These can be: day, week, month and year. The response contains a list of points each representing the given time unit.
unit
string
Possible values: day
, week
, month
, year
Default: Based on the given time period (Ex: for a year default will be month).
Get visits information as graph data
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
type | string Value: "time-series" Example: type=time-series |
unit | string Enum: "day" "week" "month" "year" Example: unit=day |
{- "payload": {
- "datasets": [
- {
- "label": "Overall Page Visits",
- "data": [
- 32,
- 50,
- 80
]
}
], - "labels": [
- "2022-06-22T15:46:47Z"
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
type required | string Enum: "time-series" "pie" "bar" Example: type=time-series |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "payload": {
- "labels": [
- "string"
], - "datasets": [
- {
- "label": "string",
- "data": [
- 0
]
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
type required | string Enum: "time-series" "pie" "bar" Example: type=time-series |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "payload": {
- "labels": [
- "string"
], - "datasets": [
- {
- "label": "string",
- "data": [
- 0
]
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
type required | string Enum: "time-series" "pie" "bar" Example: type=time-series |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "payload": {
- "labels": [
- "string"
], - "datasets": [
- {
- "label": "string",
- "data": [
- 0
]
}
]
}
}
Get sessions information as graph data
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
type required | string Enum: "time-series" "pie" "bar" Example: type=time-series |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "payload": {
- "labels": [
- "string"
], - "datasets": [
- {
- "label": "string",
- "data": [
- 0
]
}
]
}
}
Get sessions information as graph data
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
type required | string Enum: "time-series" "pie" "bar" Example: type=time-series |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "payload": {
- "labels": [
- "string"
], - "datasets": [
- {
- "label": "string",
- "data": [
- 0
]
}
]
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
heatmapId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a heatmap |
group | string Example: group=country Groups the results by filter. Only group by country option available |
order | string Enum: "desc" "asc" Example: order=count.asc|desc or country.desc|asc Orders the results from query ascending or descending. |
pageSize | integer Example: pageSize=20 Number of items per page to be requested |
page | integer Example: page=1 Page to be requested |
{- "payload": [
- {
- "country": "RO",
- "count": 10
}, - {
- "country": "US",
- "count": 2
}
], - "meta": {
- "page": 1,
- "pageSize": 20,
- "total": 2,
- "sessionsTotal": 12
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "payload": {
- "average-duration": 0
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
starred | string |
watched | string |
from | number <int64> |
until | number <int64> |
object | |
object | |
object | |
devices | Array of strings |
status | Array of integers |
containsPage | string |
notContainsPage | string |
object | |
object | |
entryPage | string |
exitPage | string |
object | |
referrerURLs | Array of strings |
trafficChannels | Array of strings |
adCampaignLabels | Array of strings |
{- "starred": "string",
- "watched": "string",
- "from": 0,
- "until": 0,
- "country": {
- "is": "string",
- "isNot": "string"
}, - "os": {
- "is": "string",
- "isNot": "string"
}, - "browser": {
- "is": "string",
- "isNot": "string"
}, - "devices": [
- "string"
], - "status": [
- 0
], - "containsPage": "string",
- "notContainsPage": "string",
- "durations": {
- "min": 0,
- "max": 0
}, - "pageCount": {
- "min": 0,
- "max": 0
}, - "entryPage": "string",
- "exitPage": "string",
- "funnelDropouts": {
- "id": "string",
- "level": 0
}, - "referrerURLs": [
- "string"
], - "trafficChannels": [
- "string"
], - "adCampaignLabels": [
- "string"
]
}
{- "sessionsTotal": 0,
- "data": [
- {
- "id": "string",
- "status": 0,
- "countryCode": "string",
- "sessionStart": 0,
- "referrer": "string",
- "platform": "string",
- "device": "string",
- "browser": "string",
- "screenSize": "string",
- "location": {
- "lat": 0,
- "lng": 0
}, - "visitorId": "string",
- "entryPage": "string",
- "exitPage": "string",
- "ssrStatus": 0,
- "ssrInfo": {
- "pagesCount": 0,
- "duration": 0,
- "pages": [
- {
- "url": "string",
- "duration": 0,
- "timestamp": 0,
- "type": 0
}
]
}, - "sessionExtras": {
- "id": "string",
- "seen": true,
- "star": true,
- "tags": [
- "string"
]
}, - "comment": "string"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
starred | string |
watched | string |
from | number <int64> |
until | number <int64> |
object | |
object | |
object | |
devices | Array of strings |
status | Array of integers |
containsPage | string |
notContainsPage | string |
object | |
object | |
entryPage | string |
exitPage | string |
object | |
referrerURLs | Array of strings |
trafficChannels | Array of strings |
adCampaignLabels | Array of strings |
object |
{- "starred": "string",
- "watched": "string",
- "from": 0,
- "until": 0,
- "country": {
- "is": "string",
- "isNot": "string"
}, - "os": {
- "is": "string",
- "isNot": "string"
}, - "browser": {
- "is": "string",
- "isNot": "string"
}, - "devices": [
- "string"
], - "status": [
- 0
], - "containsPage": "string",
- "notContainsPage": "string",
- "durations": {
- "min": 0,
- "max": 0
}, - "pageCount": {
- "min": 0,
- "max": 0
}, - "entryPage": "string",
- "exitPage": "string",
- "funnelDropouts": {
- "id": "string",
- "level": 0
}, - "referrerURLs": [
- "string"
], - "trafficChannels": [
- "string"
], - "adCampaignLabels": [
- "string"
], - "tags": {
- "property1": "string",
- "property2": "string"
}
}
{- "sessionsTotal": 0,
- "data": [
- {
- "id": "string",
- "status": 0,
- "countryCode": "string",
- "sessionStart": 0,
- "referrer": "string",
- "platform": "string",
- "device": "string",
- "browser": "string",
- "screenSize": "string",
- "location": {
- "lat": 0,
- "lng": 0
}, - "visitorId": "string",
- "entryPage": "string",
- "exitPage": "string",
- "ssrStatus": 0,
- "ssrInfo": {
- "pagesCount": 0,
- "duration": 0,
- "pages": [
- {
- "url": "string",
- "duration": 0,
- "timestamp": 0,
- "type": 0
}
]
}, - "sessionExtras": {
- "id": "string",
- "seen": true,
- "star": true,
- "tags": [
- "string"
]
}, - "comment": "string",
- "tags": {
- "property1": "string",
- "property2": "string"
}
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
sessionIds | Array of strings |
{- "sessionIds": [
- "string"
]
}
{- "error": {
- "code": "server_error",
- "message": "this is error response",
- "details": { }
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
starred | string |
watched | string |
from | number <int64> |
until | number <int64> |
object | |
object | |
object | |
devices | Array of strings |
status | Array of integers |
containsPage | string |
notContainsPage | string |
object | |
object | |
entryPage | string |
exitPage | string |
object | |
referrerURLs | Array of strings |
trafficChannels | Array of strings |
adCampaignLabels | Array of strings |
{- "starred": "string",
- "watched": "string",
- "from": 0,
- "until": 0,
- "country": {
- "is": "string",
- "isNot": "string"
}, - "os": {
- "is": "string",
- "isNot": "string"
}, - "browser": {
- "is": "string",
- "isNot": "string"
}, - "devices": [
- "string"
], - "status": [
- 0
], - "containsPage": "string",
- "notContainsPage": "string",
- "durations": {
- "min": 0,
- "max": 0
}, - "pageCount": {
- "min": 0,
- "max": 0
}, - "entryPage": "string",
- "exitPage": "string",
- "funnelDropouts": {
- "id": "string",
- "level": 0
}, - "referrerURLs": [
- "string"
], - "trafficChannels": [
- "string"
], - "adCampaignLabels": [
- "string"
]
}
{- "sessionsTotal": 0,
- "data": [
- {
- "id": "string",
- "status": 0,
- "countryCode": "string",
- "sessionStart": 0,
- "referrer": "string",
- "platform": "string",
- "device": "string",
- "browser": "string",
- "screenSize": "string",
- "location": {
- "lat": 0,
- "lng": 0
}, - "visitorId": "string",
- "entryPage": "string",
- "exitPage": "string",
- "ssrStatus": 0,
- "ssrInfo": {
- "pagesCount": 0,
- "duration": 0,
- "pages": [
- {
- "url": "string",
- "duration": 0,
- "timestamp": 0,
- "type": 0
}
]
}, - "sessionExtras": {
- "id": "string",
- "seen": true,
- "star": true,
- "tags": [
- "string"
]
}, - "comment": "string"
}
]
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter (default = until - 7 days) |
until | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter (default = today's date) |
previousFrom | string <date-time> (ISO8601) Example: previousFrom=2018-01-01T00:00:00.000Z Lower bound date filter; optional |
previousUntil | string <date-time> (ISO8601) Example: previousUntil=2022-04-18T22:59:59.000Z Upper bound date filter; optional |
status | number Enum: 0 1 2 0 = pending or draft status, 1 = active status, 2 = limit reached status |
search | string Example: search=string Regex for funnel name |
order | string Enum: "desc" "asc" Example: order=count.asc|desc (only count ordering option) TO BE IMPLEMENTED |
{- "payload": [
- {
- "key": "id-string",
- "name": "Test funnel",
- "visitorLimit": 10000,
- "visitorCount": 0,
- "visitorCountInTimeRange": 2700,
- "visitorCountInPreviousTimeRange": 0,
- "createdAt": 1584451370,
- "createdBy": "id-string",
- "levels": [
- {
- "url": "www.test1.com",
- "name": "step 1",
- "type": 0,
- "match": 1
}, - {
- "url": "www.test2.com",
- "name": "step 2",
- "type": 0,
- "match": 1
}, - {
- "url": "www.test3.com",
- "name": "step 3",
- "type": 0,
- "match": 1
}
], - "status": 0,
- "expectedConversionRate": 50,
- "conversionRate": 37.04,
- "previousConversionRate": 0,
- "currentConversion": 1000,
- "previousConversion": 0
}
]
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
funnelId required | string Funnel ID |
from | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter (default = until - 7 days) |
until | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter (default = today's date) |
previousFrom | string <date-time> (ISO8601) Example: previousFrom=2018-01-01T00:00:00.000Z Lower bound date filter; optional |
previousUntil | string <date-time> (ISO8601) Example: previousUntil=2022-04-18T22:59:59.000Z Upper bound date filter; optional |
{- "payload": {
- "key": "id-string",
- "name": "Test funnel",
- "visitorLimit": 10000,
- "visitorCount": 0,
- "visitorCountInTimeRange": 2700,
- "visitorCountInPreviousTimeRange": 0,
- "createdAt": 1584451370,
- "createdBy": "id-string",
- "levels": [
- {
- "url": "www.test1.com",
- "name": "step 1",
- "type": 0,
- "match": 1
}, - {
- "url": "www.test2.com",
- "name": "step 2",
- "type": 0,
- "match": 1
}, - {
- "url": "www.test3.com",
- "name": "step 3",
- "type": 0,
- "match": 1
}
], - "status": 0,
- "expectedConversionRate": 50,
- "conversionRate": 37.04,
- "previousConversionRate": 0,
- "currentConversion": 1000,
- "previousConversion": 0,
- "levelsConversionData": [
- {
- "totalVisitors": 4050,
- "conversionRate": 100,
- "dropoutsVisitors": 0,
- "dropoutsRate": 0
}, - {
- "totalVisitors": 2225,
- "conversionRate": 54.93,
- "dropoutsVisitors": 1825,
- "dropoutsRate": 45.06
}
]
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
funnelIds | Array of strings |
{- "funnelIds": [
- "funnel_id_1",
- "funnel_id_2",
- "funnel_id_3"
]
}
{- "error": "INVALID_CONTENT_TYPE"
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
{- "payload": [
- {
- "average-conversion-rate": "int"
}
]
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
{- "payload": [
- {
- "highest-conversion-rate": "int"
}
]
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter. |
page | integer Example: page=1 Page to be requested |
pageSize | integer Example: pageSize=20 Number of items per page to be requested |
action, category, label, pageTitle, element | string action, category, label, pageTitle, element are allowed in text filtering results by one or more terms |
group | string one or more columns to group by ( format is option1,option2). Allowed options are 'action', 'category', 'value', 'label', 'pageTitle', 'element', 'type' |
order | string one ore more columns to order by 'asc' or 'desc' (format is option1.asc,option2.desc). If no direction is provided for a column 'desc' is assumed. Allowed options are 'action', 'category', 'value', 'label', 'pageTitle', 'element', 'type', 'createdAt' |
{- "payload": [
- {
- "key": "string",
- "createdAt": "2022-09-27T13:32:01.085Z",
- "websiteKey": "string",
- "sessionKey": "string",
- "visitKey": "string",
- "pageKey": "string",
- "pageTitle": "Support",
- "domPathKey": "string",
- "deviceType": "desktop",
- "action": "onmouseover",
- "category": "textarea",
- "label": "textarea",
- "type": 2,
- "element": "string",
- "fieldsObject": "string",
- "value": "string"
}
], - "meta": {
- "total": 10,
- "page": 10,
- "pageSize": 10
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter. |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
action, category, label, pageTitle, element | string action, category, label, pageTitle, element are allowed in text filtering results by one or more terms |
group | string one or more columns to group by ( format is option1,option2). Allowed options are 'action', 'category', 'value', 'label', 'pageTitle', 'element', 'type' |
{- "payload": {
- "current": [
- {
- "timeInterval": {
- "from": "2022-08-29T22:00:00.000Z",
- "until": "2022-08-29T23:59:59.999Z"
}, - "groupBy": "websiteKey",
- "itemGroups": [
- {
- "groupValue": "string",
- "itemsInGroup": 55482
}
]
}
], - "previous": [
- {
- "timeInterval": {
- "from": "2022-07-29T22:00:00.001Z",
- "until": "2022-07-29T23:59:59.999Z"
}, - "groupBy": "websiteKey",
- "itemGroups": [
- {
- "groupValue": "string",
- "itemsInGroup": 35
}
]
}
]
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
page | integer Example: page=1 Page to be requested |
pageSize | integer Example: pageSize=20 Number of items per page to be requested |
name | string Filters the result based by custom event name. Multiple values are allowed (ex 'name=action,example') |
{- "payload": [
- {
- "key": "id-string",
- "name": "name-string",
- "createdAt": 1584451370,
- "websiteKey": "id-string",
- "value": {
- "group": [
- "action"
], - "order": {
- "name": "category",
- "value": "desc"
}
}
}
], - "meta": {
- "total": 10,
- "page": 10,
- "pageSize": 10
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
name | string Represents the filter name |
object |
{- "name": "Order by action",
- "value": {
- "page": 2,
- "pageSize": 25,
- "action": "Click",
- "category": "Video",
- "group": [
- "action"
], - "order": [
- {
- "name": "category",
- "value": "desc"
}
]
}
}
{- "payload": {
- "key": "id-string",
- "name": "Order by action",
- "createdAt": 1584451370,
- "websiteKey": "id-string",
- "value": {
- "group": [
- "action"
], - "order": {
- "name": "category",
- "value": "desc"
}
}, - "filterKey": "id-string"
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
filterId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a custom events filter |
name | string Represents the filter name |
{- "name": "Order by action edit"
}
{- "payload": {
- "key": "id-string",
- "name": "Order by action edit",
- "createdAt": 1584451370,
- "websiteKey": "id-string",
- "value": {
- "group": [
- "action"
], - "order": {
- "name": "category",
- "value": "desc"
}
}, - "filterKey": "id-string"
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
filterId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a custom events filter |
{- "payload": {
- "key": "id-string"
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
title | string Represents the survey title |
language | string |
status | integer Available options are 1 (Inactive), 2 (Draft), 3 (Active) |
logoId | string Logo id uuid. It is obtained after a file upload |
advertising | boolean |
Array of objects | |
object | |
object |
{- "title": "My first survey",
- "language": "en",
- "status": 2,
- "logoId": "string",
- "advertising": true,
- "questions": [
- {
- "body": "What city do you like the most?",
- "type": 1,
- "required": false,
- "hasDescription": false
}, - {
- "body": "What city do you like the most and why?",
- "type": 2,
- "required": false,
- "hasDescription": false
}, - {
- "body": "What city do you like the most?",
- "type": 3,
- "required": false,
- "hasDescription": false,
- "multipleChoice": true,
- "choices": [
- "London",
- "Paris",
- "Barcelona",
- "Berlin",
- "Budapest"
]
}, - {
- "body": "How much do you like Paris?",
- "type": 4,
- "required": false,
- "labels": true,
- "choices": [
- "low",
- "medium",
- "high"
], - "hasDescription": false
}, - {
- "body": "On a scale from 1 to 5 how much do you like Barcelona?",
- "type": 5,
- "required": false,
- "labels": true,
- "steps": 5,
- "choices": [
- "low",
- "medium",
- "high"
], - "hasDescription": true,
- "shape": 2,
- "description": "This is some extra description."
}, - {
- "body": "On a scale from 1 to 5 how much do you like London?",
- "type": 6,
- "labels": true,
- "steps": 5,
- "choices": [
- "low",
- "medium",
- "high"
], - "hasDescription": false
}, - {
- "body": "What is your email address?",
- "type": 7,
- "required": false,
- "hasDescription": false
}, - {
- "body": "What is your phone number?",
- "type": 8,
- "required": false,
- "hasDescription": false
}, - {
- "body": "What is your website address?",
- "type": 9,
- "required": false,
- "hasDescription": false
}, - {
- "body": "What is your birth date?",
- "type": 10,
- "required": false,
- "hasDescription": false
}
], - "appearance": {
- "mainColor": "#0C635A",
- "backgroundColor": "#FFFFFF",
- "estimatedTimeToComplete": 5
}, - "settings": {
- "visualization": 1,
- "progressBar": true,
}
}
{- "payload": {
- "id": "string-id",
- "createdAt": 1664345317,
- "title": "My first survey",
- "language": "en",
- "status": 2,
- "advertising": true,
- "questions": [
- {
- "id": "id-string",
- "body": "What city do you like the most?",
- "type": 1,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What city do you like the most and why?",
- "type": 2,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What city do you like the most?",
- "type": 3,
- "required": false,
- "choices": [
- "London",
- "Paris",
- "Barcelona",
- "Berlin",
- "Budapest"
], - "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": true,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "How much do you like Paris?",
- "type": 4,
- "required": false,
- "choices": [
- "low",
- "medium",
- "high"
], - "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": true,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "On a scale from 1 to 5 how much do you like Barcelona?",
- "type": 5,
- "required": false,
- "choices": [
- "low",
- "medium",
- "high"
], - "createdAt": 1664345317,
- "description": "This is some extra description.",
- "inBank": false,
- "labels": true,
- "multipleChoice": null,
- "shape": 2,
- "steps": 5
}, - {
- "id": "id-string",
- "body": "On a scale from 1 to 5 how much do you like London?",
- "type": 6,
- "required": false,
- "choices": [
- "low",
- "medium",
- "high"
], - "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": true,
- "multipleChoice": null,
- "shape": null,
- "steps": 5
}, - {
- "id": "id-string",
- "body": "What is your email address?",
- "type": 7,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What is your phone number?",
- "type": 8,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What is your website address?",
- "type": 9,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What is your birth date?",
- "type": 10,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}
], - "appearance": {
- "mainColor": "#0C635A",
- "backgroundColor": "#FFFFFF",
- "estimatedTimeToComplete": 5
}, - "settings": {
- "visualization": 1,
- "progressBar": true,
}
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
{- "payload": [
- {
- "id": "string-id",
- "createdAt": 1664345317,
- "title": "My first survey",
- "language": "en",
- "status": 2,
- "advertising": true,
- "websiteId": "string-id",
- "generalStats": {
- "initiates": 59,
- "responses": 412,
- "completionRate": 98.31,
- "averageCompletionTime": 153,
- "answersPerQuestion": [
- 59,
- 59,
- 59,
- 59,
- 59,
- 59,
- 59,
- 59,
- 59,
- 58
]
}
}
]
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
Survey questions will always be included in the response.
Appearance & Settings can be added to the response by using: appearance=true AND/OR settings=true
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
surveyId required | string ID of a survey. Pattern is [a-f\d]{24} |
{- "payload": {
- "id": "string-id",
- "createdAt": 1664345317,
- "title": "My first survey",
- "language": "en",
- "status": 2,
- "advertising": true,
- "questions": [
- {
- "id": "id-string",
- "body": "What city do you like the most?",
- "type": 1,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What city do you like the most and why?",
- "type": 2,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What city do you like the most?",
- "type": 3,
- "required": false,
- "choices": [
- "London",
- "Paris",
- "Barcelona",
- "Berlin",
- "Budapest"
], - "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": true,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "How much do you like Paris?",
- "type": 4,
- "required": false,
- "choices": [
- "low",
- "medium",
- "high"
], - "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": true,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "On a scale from 1 to 5 how much do you like Barcelona?",
- "type": 5,
- "required": false,
- "choices": [
- "low",
- "medium",
- "high"
], - "createdAt": 1664345317,
- "description": "This is some extra description.",
- "inBank": false,
- "labels": true,
- "multipleChoice": null,
- "shape": 2,
- "steps": 5
}, - {
- "id": "id-string",
- "body": "On a scale from 1 to 5 how much do you like London?",
- "type": 6,
- "required": false,
- "choices": [
- "low",
- "medium",
- "high"
], - "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": true,
- "multipleChoice": null,
- "shape": null,
- "steps": 5
}, - {
- "id": "id-string",
- "body": "What is your email address?",
- "type": 7,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What is your phone number?",
- "type": 8,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What is your website address?",
- "type": 9,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What is your birth date?",
- "type": 10,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}
], - "appearance": {
- "mainColor": "#0C635A",
- "backgroundColor": "#FFFFFF",
- "estimatedTimeToComplete": 5
}, - "settings": {
- "visualization": 1,
- "progressBar": true,
}
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
Once the survey has status 1 (Inactive) or 3 (Active) you can not edit the survey anymore.
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
surveyId required | string ID of a survey. Pattern is [a-f\d]{24} |
title | string Represents the survey title |
language | string |
status | integer Available options are 1 (Inactive), 2 (Draft), 3 (Active) |
logoId | string Logo id uuid. It is obtained after a file upload |
advertising | boolean |
Array of objects | |
object | |
object |
{- "title": "My first survey",
- "language": "en",
- "status": 2,
- "logoId": "string",
- "advertising": true,
- "questions": [
- {
- "id": "id-string",
- "body": "What city do you like the most?",
- "type": 1,
- "required": false,
- "hasDescription": false
}, - {
- "id": "id-string",
- "body": "What city do you like the most and why?",
- "type": 2,
- "required": false,
- "hasDescription": false
}, - {
- "id": "id-string",
- "body": "What city do you like the most?",
- "type": 3,
- "required": false,
- "hasDescription": false,
- "multipleChoice": true,
- "choices": [
- "London",
- "Paris",
- "Barcelona",
- "Berlin",
- "Budapest"
]
}, - {
- "id": "id-string",
- "body": "How much do you like Paris?",
- "type": 4,
- "required": false,
- "labels": true,
- "choices": [
- "low",
- "medium",
- "high"
], - "hasDescription": false
}, - {
- "id": "id-string",
- "body": "On a scale from 1 to 5 how much do you like Barcelona?",
- "type": 5,
- "required": false,
- "labels": true,
- "steps": 5,
- "choices": [
- "low",
- "medium",
- "high"
], - "hasDescription": true,
- "shape": 2,
- "description": "This is some extra description."
}, - {
- "id": "id-string",
- "body": "On a scale from 1 to 5 how much do you like London?",
- "type": 6,
- "labels": true,
- "steps": 5,
- "choices": [
- "low",
- "medium",
- "high"
], - "hasDescription": false
}, - {
- "id": "id-string",
- "body": "What is your email address?",
- "type": 7,
- "required": false,
- "hasDescription": false
}, - {
- "id": "id-string",
- "body": "What is your phone number?",
- "type": 8,
- "required": false,
- "hasDescription": false
}, - {
- "id": "id-string",
- "body": "What is your website address?",
- "type": 9,
- "required": false,
- "hasDescription": false
}, - {
- "id": "id-string",
- "body": "What is your birth date?",
- "type": 10,
- "required": false,
- "hasDescription": false
}
], - "appearance": {
- "mainColor": "#0C635A",
- "backgroundColor": "#FFFFFF",
- "estimatedTimeToComplete": 5
}, - "settings": {
- "visualization": 1,
- "progressBar": true,
}
}
{- "payload": {
- "id": "string-id",
- "createdAt": 1664345317,
- "title": "My first survey",
- "language": "en",
- "status": 2,
- "advertising": true,
- "questions": [
- {
- "id": "id-string",
- "body": "What city do you like the most?",
- "type": 1,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What city do you like the most and why?",
- "type": 2,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What city do you like the most?",
- "type": 3,
- "required": false,
- "choices": [
- "London",
- "Paris",
- "Barcelona",
- "Berlin",
- "Budapest"
], - "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": true,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "How much do you like Paris?",
- "type": 4,
- "required": false,
- "choices": [
- "low",
- "medium",
- "high"
], - "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": true,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "On a scale from 1 to 5 how much do you like Barcelona?",
- "type": 5,
- "required": false,
- "choices": [
- "low",
- "medium",
- "high"
], - "createdAt": 1664345317,
- "description": "This is some extra description.",
- "inBank": false,
- "labels": true,
- "multipleChoice": null,
- "shape": 2,
- "steps": 5
}, - {
- "id": "id-string",
- "body": "On a scale from 1 to 5 how much do you like London?",
- "type": 6,
- "required": false,
- "choices": [
- "low",
- "medium",
- "high"
], - "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": true,
- "multipleChoice": null,
- "shape": null,
- "steps": 5
}, - {
- "id": "id-string",
- "body": "What is your email address?",
- "type": 7,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What is your phone number?",
- "type": 8,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What is your website address?",
- "type": 9,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What is your birth date?",
- "type": 10,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}
], - "appearance": {
- "mainColor": "#0C635A",
- "backgroundColor": "#FFFFFF",
- "estimatedTimeToComplete": 5
}, - "settings": {
- "visualization": 1,
- "progressBar": true,
}
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
surveyId required | string ID of a survey. Pattern is [a-f\d]{24} |
{- "error": {
- "code": "server_error",
- "message": "this is error response",
- "details": { }
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
surveyId required | string ID of a survey. Pattern is [a-f\d]{24} |
status | integer Available options are 1 (Inactive), 3 (Active) |
{- "status": 3
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
{- "payload": {
- "count": 3
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
This endpoint will return avalid response only for question having type 1 (Short Answer). For any other question types will return nulls in response
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
surveyId required | string ID of a survey. Pattern is [a-f\d]{24} |
questionId required | string ID of a survey question. Pattern is [a-f\d]{24} |
{- "payload": {
- "id": "string-id",
- "type": 1,
- "body": "What city do you like the most?",
- "description": "This is some extra description.",
- "answerCount": 6,
- "answers": [
- {
- "body": "I like Paris",
- "visitor": null,
- "createdAt": 1664345317
}, - {
- "body": "Barcelona",
- "visitor": null,
- "createdAt": 1664345417
}, - {
- "body": "None",
- "visitor": null,
- "createdAt": 1664345427
}, - {
- "body": "What question is this?",
- "visitor": null,
- "createdAt": 1664346317
}, - {
- "body": "this is a test response",
- "visitor": null,
- "createdAt": 1664346417
}, - {
- "body": "NewYork",
- "visitor": null,
- "createdAt": 1664346617
}
]
}
}
Authentication is not needed.
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
surveyId required | string ID of a survey. Pattern is [a-f\d]{24} |
questionId required | string ID of a survey question. Pattern is [a-f\d]{24} |
body | string Represents the answer for Short Answer, Long Answer, Email, Website, Phone, Date |
value | integer Represents the answer for Slider, Rating, Rating Scale |
choices | Array of arrays |
visitorKey | string |
shownAt | timestamp |
{- "body": "My first answer",
- "value": 2,
- "choices": [
- "choice1",
- "choice3"
], - "visitorKey": "string",
- "shownAt": 1608209339
}
{- "error": {
- "code": "server_error",
- "message": "this is error response",
- "details": { }
}
}
Authentication not needed. Survey questions will always be included in the response. Appearance & Settings can be added to the response by using: appearance=true AND/OR settings=true
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
surveyId required | string ID of a survey. Pattern is [a-f\d]{24} |
{- "payload": {
- "id": "string-id",
- "createdAt": 1664345317,
- "title": "My first survey",
- "language": "en",
- "status": 3,
- "advertising": true,
- "questions": [
- {
- "id": "id-string",
- "body": "What city do you like the most?",
- "type": 1,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What city do you like the most and why?",
- "type": 2,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What city do you like the most?",
- "type": 3,
- "required": false,
- "choices": [
- "London",
- "Paris",
- "Barcelona",
- "Berlin",
- "Budapest"
], - "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": true,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "How much do you like Paris?",
- "type": 4,
- "required": false,
- "choices": [
- "low",
- "medium",
- "high"
], - "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": true,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "On a scale from 1 to 5 how much do you like Barcelona?",
- "type": 5,
- "required": false,
- "choices": [
- "low",
- "medium",
- "high"
], - "createdAt": 1664345317,
- "description": "This is some extra description.",
- "inBank": false,
- "labels": true,
- "multipleChoice": null,
- "shape": 2,
- "steps": 5
}, - {
- "id": "id-string",
- "body": "On a scale from 1 to 5 how much do you like London?",
- "type": 6,
- "required": false,
- "choices": [
- "low",
- "medium",
- "high"
], - "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": true,
- "multipleChoice": null,
- "shape": null,
- "steps": 5
}, - {
- "id": "id-string",
- "body": "What is your email address?",
- "type": 7,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What is your phone number?",
- "type": 8,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What is your website address?",
- "type": 9,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What is your birth date?",
- "type": 10,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}
], - "appearance": {
- "mainColor": "#0C635A",
- "backgroundColor": "#FFFFFF",
- "estimatedTimeToComplete": 5
}, - "settings": {
- "visualization": 1,
- "progressBar": true,
}
}
}
Authentication is not needed
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
surveyId required | string ID of a survey. Pattern is [a-f\d]{24} |
{- "error": {
- "code": "server_error",
- "message": "this is error response",
- "details": { }
}
}
Authentication is not needed.
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
surveyId required | string ID of a survey. Pattern is [a-f\d]{24} |
body | string Represents the answer for Short Answer, Long Answer, Email, Website, Phone, Date |
value | integer Represents the answer for Slider, Rating, Rating Scale |
choices | Array of arrays |
visitorKey | string |
questionId | string |
shownAt | timestamp |
{- "body": "My first answer",
- "value": 2,
- "choices": [
- "choice1",
- "choice3"
], - "visitorKey": "string",
- "questionId": "question-id",
- "shownAt": 1608209339
}
{- "error": {
- "code": "server_error",
- "message": "this is error response",
- "details": { }
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
{- "payload": {
- "average-completion-rate": 25.5
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
{- "payload": {
- "count": 400
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
{- "payload": {
- "count": 10
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
{- "payload": {
- "totalAnswersCount": 131,
- "questions": [
- {
- "id": "id-string",
- "type": 1,
- "body": "What city do you like the most?",
- "description": "Question Short Answer Description",
- "answerCount": 20,
- "answer": [
- {
- "body": "answer short 1",
- "visitor": null,
- "createdAt": 1597939200
}
]
}, - {
- "id": "id-string",
- "body": "What city do you like the most and why?",
- "type": 2,
- "description": "Question Long Answer Description",
- "answerCount": 20,
- "answer": [
- {
- "body": "answer long 1",
- "visitor": null,
- "createdAt": 1597939200
}
]
}, - {
- "id": "id-string",
- "body": "What city do you like the most?",
- "description": "Question Multiple Choice Description",
- "type": 3,
- "required": false,
- "answerCount": 17,
- "answers": [
- {
- "London": 1
}, - {
- "Paris": 0
}, - {
- "Barcelona": 10
}, - {
- "Berlin": 4
}, - {
- "Budapest": 2
}
]
}, - {
- "id": "id-string",
- "body": "How much do you like Paris?",
- "description": "Question Slider Description",
- "type": 4,
- "labels": [
- "low",
- "medium",
- "high"
], - "answerCount": 16,
- "average": 10
}, - {
- "id": "id-string",
- "body": "On a scale from 1 to 5 how much do you like Barcelona?",
- "description": "Question Rating Description",
- "type": 5,
- "labels": [
- "low",
- "medium",
- "high"
], - "answerCount": 15,
- "answers": [
- 1,
- 7,
- 7
]
}, - {
- "id": "id-string",
- "body": "On a scale from 1 to 5 how much do you like London?",
- "type": 6,
- "description": "Question Scale Description",
- "labels": [
- "low",
- "medium",
- "high"
], - "answerCount": 15,
- "answers": [
- 1,
- 6,
- 8
]
}, - {
- "id": "id-string",
- "body": "What is your email address?",
- "description": "Question Email Description",
- "type": 7,
- "answerCount": 10,
- "answers": [
- {
- "body": "my-email",
- "visitor": null,
- "createdAt": 1597939200
}
]
}, - {
- "id": "id-string",
- "body": "What is your phone number?",
- "description": "Question Phone Description",
- "type": 8,
- "answerCount": 10,
- "answers": [
- {
- "body": "my-phone",
- "visitor": null,
- "createdAt": 1597939200
}
]
}, - {
- "id": "id-string",
- "body": "What is your website address?",
- "description": "Question Website Description",
- "type": 9,
- "answerCount": 5,
- "answers": [
- {
- "body": "my-website",
- "visitor": null,
- "createdAt": 1597939200
}
]
}, - {
- "id": "id-string",
- "body": "What is your birth date?",
- "description": "Question Date Description",
- "type": 10,
- "answerCount": 3,
- "answers": [
- {
- "body": "my-birthday",
- "visitor": null,
- "createdAt": 1597939200
}
]
}
]
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
{- "payload": {
- "surveyId": "survey-id",
- "initiates": 6,
- "responses": 6,
- "averageCompletionTime": 50,
- "completionRate": 25.5,
- "answersPerQuestion": [
- 20,
- 20,
- 17,
- 16,
- 15,
- 15,
- 10,
- 10,
- 5,
- 3
]
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
title | string Represents the poll title |
language | string |
status | integer Available options are 1 (Inactive), 2 (Draft), 3 (Active) |
logoId | string Logo id uuid. It is obtained after a file upload |
advertising | boolean |
dismissible | boolean |
Array of objects | |
object | |
object |
{- "title": "My first poll",
- "language": "en",
- "status": 2,
- "logoId": "string",
- "advertising": true,
- "dismissible": true,
- "questions": [
- {
- "body": "What city do you like the most?",
- "type": 1,
- "required": false,
- "hasDescription": false
}, - {
- "body": "What city do you like the most and why?",
- "type": 2,
- "required": false,
- "hasDescription": false
}, - {
- "body": "What city do you like the most?",
- "type": 3,
- "required": false,
- "hasDescription": false,
- "multipleChoice": true,
- "choices": [
- "London",
- "Paris",
- "Barcelona",
- "Berlin",
- "Budapest"
]
}, - {
- "body": "How much do you like Paris?",
- "type": 4,
- "required": false,
- "labels": true,
- "choices": [
- "low",
- "medium",
- "high"
], - "hasDescription": false
}, - {
- "body": "On a scale from 1 to 5 how much do you like Barcelona?",
- "type": 5,
- "required": false,
- "labels": true,
- "steps": 5,
- "choices": [
- "low",
- "medium",
- "high"
], - "hasDescription": true,
- "shape": 2,
- "description": "This is some extra description."
}, - {
- "body": "On a scale from 1 to 5 how much do you like London?",
- "type": 6,
- "labels": true,
- "steps": 5,
- "choices": [
- "low",
- "medium",
- "high"
], - "hasDescription": false
}, - {
- "body": "What is your email address?",
- "type": 7,
- "required": false,
- "hasDescription": false
}, - {
- "body": "What is your phone number?",
- "type": 8,
- "required": false,
- "hasDescription": false
}, - {
- "body": "What is your website address?",
- "type": 9,
- "required": false,
- "hasDescription": false
}, - {
- "body": "What is your birth date?",
- "type": 10,
- "required": false,
- "hasDescription": false
}
], - "appearance": {
- "mainColor": "#0C635A",
- "backgroundColor": "#FFFFFF",
- "bubblePosition": 1,
- "hPadding": 10,
- "vPadding": 10
}, - "targeting": {
- "showOn": [
- [
- {
- "type": 1,
- "value": "example.com"
}, - {
- "type": 3,
- "value": "example.com"
}, - {
- "type": 4,
- "value": "example"
}, - {
- "type": 5,
- "value": "example=example"
}
]
], - "hideOn": [
- [
- {
- "type": 1,
- "value": "example.com"
}, - {
- "type": 3,
- "value": "example.com"
}, - {
- "type": 4,
- "value": "example"
}
]
]
}
}
{- "payload": {
- "id": "string-id",
- "createdAt": 1664345317,
- "title": "My first poll",
- "language": "en",
- "status": 2,
- "advertising": true,
- "dismissible": true,
- "questions": [
- {
- "id": "id-string",
- "body": "What city do you like the most?",
- "type": 1,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What city do you like the most and why?",
- "type": 2,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What city do you like the most?",
- "type": 3,
- "required": false,
- "choices": [
- "London",
- "Paris",
- "Barcelona",
- "Berlin",
- "Budapest"
], - "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": true,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "How much do you like Paris?",
- "type": 4,
- "required": false,
- "choices": [
- "low",
- "medium",
- "high"
], - "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": true,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "On a scale from 1 to 5 how much do you like Barcelona?",
- "type": 5,
- "required": false,
- "choices": [
- "low",
- "medium",
- "high"
], - "createdAt": 1664345317,
- "description": "This is some extra description.",
- "inBank": false,
- "labels": true,
- "multipleChoice": null,
- "shape": 2,
- "steps": 5
}, - {
- "id": "id-string",
- "body": "On a scale from 1 to 5 how much do you like London?",
- "type": 6,
- "required": false,
- "choices": [
- "low",
- "medium",
- "high"
], - "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": true,
- "multipleChoice": null,
- "shape": null,
- "steps": 5
}, - {
- "id": "id-string",
- "body": "What is your email address?",
- "type": 7,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What is your phone number?",
- "type": 8,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What is your website address?",
- "type": 9,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What is your birth date?",
- "type": 10,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}
], - "appearance": {
- "mainColor": "#0C635A",
- "backgroundColor": "#FFFFFF",
- "bubblePosition": 1,
- "hPadding": 10,
- "vPadding": 10
}, - "targeting": {
- "showOn": [
- [
- {
- "type": 1,
- "value": "example.com"
}, - {
- "type": 3,
- "value": "example.com"
}, - {
- "type": 4,
- "value": "example"
}, - {
- "type": 5,
- "value": "example=example"
}
]
], - "hideOn": [
- [
- {
- "type": 1,
- "value": "example.com"
}, - {
- "type": 3,
- "value": "example.com"
}, - {
- "type": 4,
- "value": "example"
}
]
]
}
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
{- "payload": [
- {
- "id": "string-id",
- "createdAt": 1664345317,
- "title": "My first poll",
- "language": "en",
- "status": 2,
- "advertising": true,
- "dismissible": true,
- "websiteId": "string-id",
- "generalStats": {
- "initiates": 59,
- "responses": 412,
- "completionRate": 98.31,
- "averageCompletionTime": 153,
- "answersPerQuestion": [
- 59,
- 59,
- 59,
- 59,
- 59,
- 59,
- 59,
- 59,
- 59,
- 58
], - "dismissals": 1
}
}
]
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
Poll questions will always be included in the response.
Appearance & Targeting can be added to the response by using: appearance=true AND/OR targeting=true
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
pollId required | string ID of a poll. Pattern is [a-f\d]{24} |
{- "payload": {
- "id": "string-id",
- "createdAt": 1664345317,
- "title": "My first Poll",
- "language": "en",
- "status": 2,
- "advertising": true,
- "dismissible": true,
- "questions": [
- {
- "id": "id-string",
- "body": "What city do you like the most?",
- "type": 1,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What city do you like the most and why?",
- "type": 2,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What city do you like the most?",
- "type": 3,
- "required": false,
- "choices": [
- "London",
- "Paris",
- "Barcelona",
- "Berlin",
- "Budapest"
], - "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": true,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "How much do you like Paris?",
- "type": 4,
- "required": false,
- "choices": [
- "low",
- "medium",
- "high"
], - "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": true,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "On a scale from 1 to 5 how much do you like Barcelona?",
- "type": 5,
- "required": false,
- "choices": [
- "low",
- "medium",
- "high"
], - "createdAt": 1664345317,
- "description": "This is some extra description.",
- "inBank": false,
- "labels": true,
- "multipleChoice": null,
- "shape": 2,
- "steps": 5
}, - {
- "id": "id-string",
- "body": "On a scale from 1 to 5 how much do you like London?",
- "type": 6,
- "required": false,
- "choices": [
- "low",
- "medium",
- "high"
], - "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": true,
- "multipleChoice": null,
- "shape": null,
- "steps": 5
}, - {
- "id": "id-string",
- "body": "What is your email address?",
- "type": 7,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What is your phone number?",
- "type": 8,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What is your website address?",
- "type": 9,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What is your birth date?",
- "type": 10,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}
], - "appearance": {
- "mainColor": "#0C635A",
- "backgroundColor": "#FFFFFF",
- "bubblePosition": 1,
- "hPadding": 10,
- "vPadding": 10
}, - "targeting": {
- "showOn": [
- [
- {
- "type": 1,
- "value": "example.com"
}, - {
- "type": 3,
- "value": "example.com"
}, - {
- "type": 4,
- "value": "example"
}, - {
- "type": 5,
- "value": "example=example"
}
]
], - "hideOn": [
- [
- {
- "type": 1,
- "value": "example.com"
}, - {
- "type": 3,
- "value": "example.com"
}, - {
- "type": 4,
- "value": "example"
}
]
]
}
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
Once the poll has status 1 (Inactive) or 3 (Active) you can not edit the poll anymore.
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
pollId required | string ID of a poll. Pattern is [a-f\d]{24} |
title | string Represents the poll title |
language | string |
status | integer Available options are 1 (Inactive), 2 (Draft), 3 (Active) |
logoId | string Logo id uuid. It is obtained after a file upload |
advertising | boolean |
dismissible | boolean |
Array of objects | |
object | |
object |
{- "title": "My first poll",
- "language": "en",
- "status": 2,
- "logoId": "string",
- "advertising": true,
- "dismissible": true,
- "questions": [
- {
- "id": "id-string",
- "body": "What city do you like the most?",
- "type": 1,
- "required": false,
- "hasDescription": false
}, - {
- "id": "id-string",
- "body": "What city do you like the most and why?",
- "type": 2,
- "required": false,
- "hasDescription": false
}, - {
- "id": "id-string",
- "body": "What city do you like the most?",
- "type": 3,
- "required": false,
- "hasDescription": false,
- "multipleChoice": true,
- "choices": [
- "London",
- "Paris",
- "Barcelona",
- "Berlin",
- "Budapest"
]
}, - {
- "id": "id-string",
- "body": "How much do you like Paris?",
- "type": 4,
- "required": false,
- "labels": true,
- "choices": [
- "low",
- "medium",
- "high"
], - "hasDescription": false
}, - {
- "id": "id-string",
- "body": "On a scale from 1 to 5 how much do you like Barcelona?",
- "type": 5,
- "required": false,
- "labels": true,
- "steps": 5,
- "choices": [
- "low",
- "medium",
- "high"
], - "hasDescription": true,
- "shape": 2,
- "description": "This is some extra description."
}, - {
- "id": "id-string",
- "body": "On a scale from 1 to 5 how much do you like London?",
- "type": 6,
- "labels": true,
- "steps": 5,
- "choices": [
- "low",
- "medium",
- "high"
], - "hasDescription": false
}, - {
- "id": "id-string",
- "body": "What is your email address?",
- "type": 7,
- "required": false,
- "hasDescription": false
}, - {
- "id": "id-string",
- "body": "What is your phone number?",
- "type": 8,
- "required": false,
- "hasDescription": false
}, - {
- "id": "id-string",
- "body": "What is your website address?",
- "type": 9,
- "required": false,
- "hasDescription": false
}, - {
- "id": "id-string",
- "body": "What is your birth date?",
- "type": 10,
- "required": false,
- "hasDescription": false
}
], - "appearance": {
- "mainColor": "#0C635A",
- "backgroundColor": "#FFFFFF",
- "bubblePosition": 1,
- "hPadding": 10,
- "vPadding": 10
}, - "targeting": {
- "showOn": [
- [
- {
- "type": 1,
- "value": "example.com"
}, - {
- "type": 3,
- "value": "example.com"
}, - {
- "type": 4,
- "value": "example"
}, - {
- "type": 5,
- "value": "example=example"
}
]
], - "hideOn": [
- [
- {
- "type": 1,
- "value": "example.com"
}, - {
- "type": 3,
- "value": "example.com"
}, - {
- "type": 4,
- "value": "example"
}
]
]
}
}
{- "payload": {
- "id": "string-id",
- "createdAt": 1664345317,
- "title": "My first poll",
- "language": "en",
- "status": 2,
- "advertising": true,
- "questions": [
- {
- "id": "id-string",
- "body": "What city do you like the most?",
- "type": 1,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What city do you like the most and why?",
- "type": 2,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What city do you like the most?",
- "type": 3,
- "required": false,
- "choices": [
- "London",
- "Paris",
- "Barcelona",
- "Berlin",
- "Budapest"
], - "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": true,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "How much do you like Paris?",
- "type": 4,
- "required": false,
- "choices": [
- "low",
- "medium",
- "high"
], - "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": true,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "On a scale from 1 to 5 how much do you like Barcelona?",
- "type": 5,
- "required": false,
- "choices": [
- "low",
- "medium",
- "high"
], - "createdAt": 1664345317,
- "description": "This is some extra description.",
- "inBank": false,
- "labels": true,
- "multipleChoice": null,
- "shape": 2,
- "steps": 5
}, - {
- "id": "id-string",
- "body": "On a scale from 1 to 5 how much do you like London?",
- "type": 6,
- "required": false,
- "choices": [
- "low",
- "medium",
- "high"
], - "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": true,
- "multipleChoice": null,
- "shape": null,
- "steps": 5
}, - {
- "id": "id-string",
- "body": "What is your email address?",
- "type": 7,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What is your phone number?",
- "type": 8,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What is your website address?",
- "type": 9,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}, - {
- "id": "id-string",
- "body": "What is your birth date?",
- "type": 10,
- "required": false,
- "choices": null,
- "createdAt": 1664345317,
- "description": null,
- "inBank": false,
- "labels": null,
- "multipleChoice": null,
- "shape": null,
- "steps": null
}
], - "appearance": {
- "mainColor": "#0C635A",
- "backgroundColor": "#FFFFFF",
- "estimatedTimeToComplete": 5
}, - "targeting": {
- "showOn": [
- [
- {
- "type": 1,
- "value": "example.com"
}, - {
- "type": 3,
- "value": "example.com"
}, - {
- "type": 4,
- "value": "example"
}, - {
- "type": 5,
- "value": "example=example"
}
]
], - "hideOn": [
- [
- {
- "type": 1,
- "value": "example.com"
}, - {
- "type": 3,
- "value": "example.com"
}, - {
- "type": 4,
- "value": "example"
}
]
]
}
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
pollId required | string ID of a poll. Pattern is [a-f\d]{24} |
{- "error": {
- "code": "server_error",
- "message": "this is error response",
- "details": { }
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
pollId required | string ID of a poll. Pattern is [a-f\d]{24} |
status | integer Available options are 1 (Inactive), 3 (Active) |
{- "status": 3
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
{- "payload": {
- "count": 3
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
This endpoint will return avalid response only for question having type 1 (Short Answer). For any other question types will return nulls in response
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
pollId required | string ID of a poll. Pattern is [a-f\d]{24} |
questionId required | string ID of a poll question. Pattern is [a-f\d]{24} |
{- "payload": {
- "id": "string-id",
- "type": 1,
- "body": "What city do you like the most?",
- "description": "This is some extra description.",
- "answerCount": 6,
- "answers": [
- {
- "body": "I like Paris",
- "visitor": null,
- "createdAt": 1664345317
}, - {
- "body": "Barcelona",
- "visitor": null,
- "createdAt": 1664345417
}, - {
- "body": "None",
- "visitor": null,
- "createdAt": 1664345427
}, - {
- "body": "What question is this?",
- "visitor": null,
- "createdAt": 1664346317
}, - {
- "body": "this is a test response",
- "visitor": null,
- "createdAt": 1664346417
}, - {
- "body": "NewYork",
- "visitor": null,
- "createdAt": 1664346617
}
]
}
}
Authentication is not needed.
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
pollId required | string ID of a poll. Pattern is [a-f\d]{24} |
questionId required | string ID of a poll question. Pattern is [a-f\d]{24} |
body | string Represents the answer for Short Answer, Long Answer, Email, Website, Phone, Date |
value | integer Represents the answer for Slider, Rating, Rating Scale |
choices | Array of arrays |
visitorKey | string |
shownAt | timestamp |
{- "body": "My first answer",
- "value": 2,
- "choices": [
- "choice1",
- "choice3"
], - "visitorKey": "string",
- "shownAt": 1608209339
}
{- "error": {
- "code": "server_error",
- "message": "this is error response",
- "details": { }
}
}
Authentication is not needed
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
pollId required | string ID of a poll. Pattern is [a-f\d]{24} |
{- "error": {
- "code": "server_error",
- "message": "this is error response",
- "details": { }
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
pollId required | string ID of a poll. Pattern is [a-f\d]{24} |
visitorKey | string Represents the visitor key for which poll should be dismissed |
{- "visitorKey": "visitor-id"
}
{- "error": {
- "code": "server_error",
- "message": "this is error response",
- "details": { }
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
{- "payload": {
- "average-completion-rate": 25.5
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
{- "payload": {
- "count": 400
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
{- "payload": {
- "count": 10
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
{- "payload": {
- "totalAnswersCount": 131,
- "questions": [
- {
- "id": "id-string",
- "type": 1,
- "body": "What city do you like the most?",
- "description": "Question Short Answer Description",
- "answerCount": 20,
- "answer": [
- {
- "body": "answer short 1",
- "visitor": null,
- "createdAt": 1597939200
}
]
}, - {
- "id": "id-string",
- "body": "What city do you like the most and why?",
- "type": 2,
- "description": "Question Long Answer Description",
- "answerCount": 20,
- "answer": [
- {
- "body": "answer long 1",
- "visitor": null,
- "createdAt": 1597939200
}
]
}, - {
- "id": "id-string",
- "body": "What city do you like the most?",
- "description": "Question Multiple Choice Description",
- "type": 3,
- "required": false,
- "answerCount": 17,
- "answers": [
- {
- "London": 1
}, - {
- "Paris": 0
}, - {
- "Barcelona": 10
}, - {
- "Berlin": 4
}, - {
- "Budapest": 2
}
]
}, - {
- "id": "id-string",
- "body": "How much do you like Paris?",
- "description": "Question Slider Description",
- "type": 4,
- "labels": [
- "low",
- "medium",
- "high"
], - "answerCount": 16,
- "average": 10
}, - {
- "id": "id-string",
- "body": "On a scale from 1 to 5 how much do you like Barcelona?",
- "description": "Question Rating Description",
- "type": 5,
- "labels": [
- "low",
- "medium",
- "high"
], - "answerCount": 15,
- "answers": [
- 1,
- 7,
- 7
]
}, - {
- "id": "id-string",
- "body": "On a scale from 1 to 5 how much do you like London?",
- "type": 6,
- "description": "Question Scale Description",
- "labels": [
- "low",
- "medium",
- "high"
], - "answerCount": 15,
- "answers": [
- 1,
- 6,
- 8
]
}, - {
- "id": "id-string",
- "body": "What is your email address?",
- "description": "Question Email Description",
- "type": 7,
- "answerCount": 10,
- "answers": [
- {
- "body": "my-email",
- "visitor": null,
- "createdAt": 1597939200
}
]
}, - {
- "id": "id-string",
- "body": "What is your phone number?",
- "description": "Question Phone Description",
- "type": 8,
- "answerCount": 10,
- "answers": [
- {
- "body": "my-phone",
- "visitor": null,
- "createdAt": 1597939200
}
]
}, - {
- "id": "id-string",
- "body": "What is your website address?",
- "description": "Question Website Description",
- "type": 9,
- "answerCount": 5,
- "answers": [
- {
- "body": "my-website",
- "visitor": null,
- "createdAt": 1597939200
}
]
}, - {
- "id": "id-string",
- "body": "What is your birth date?",
- "description": "Question Date Description",
- "type": 10,
- "answerCount": 3,
- "answers": [
- {
- "body": "my-birthday",
- "visitor": null,
- "createdAt": 1597939200
}
]
}
]
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
{- "payload": {
- "pollId": "poll-id",
- "initiates": 6,
- "responses": 6,
- "averageCompletionTime": 50,
- "completionRate": 25.5,
- "answersPerQuestion": [
- 20,
- 20,
- 17,
- 16,
- 15,
- 15,
- 10,
- 10,
- 5,
- 3
], - "dismissals": 1
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
{- "payload": {
- "total": 131,
- "items": [
- {
- "visitorKey": "string-id",
- "type": 0,
- "location": "RO",
- "deviceType": "desktop",
- "platform": "linux",
- "browser": "Chrome",
- "completionTime": 5,
- "completionRate": 100,
- "completedAt": 1597939200
}
]
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
{- "payload": {
- "visitorType": 1,
- "responses": [
- {
- "questionType": 1,
- "questionContent": "What city do you like the most?",
- "questionAnswer": "answer short 1"
}, - {
- "questionType": 2,
- "questionContent": "What city do you like the most and why?",
- "questionAnswer": "answer long 1"
}, - {
- "questionType": 3,
- "questionContent": "What city do you like the most?",
- "questionAnswer": "London, Paris"
}, - {
- "questionType": 4,
- "questionContent": "How much do you like Paris?",
- "questionAnswer": "75%"
}, - {
- "questionType": 5,
- "questionContent": "On a scale from 1 to 5 how much do you like Barcelona?",
- "questionAnswer": "2/5"
}, - {
- "questionType": 6,
- "questionContent": "On a scale from 1 to 5 how much do you like London?",
- "questionAnswer": "2/5"
}, - {
- "questionType": 7,
- "questionContent": "What is your email address?",
- "questionAnswer": "my-email"
}, - {
- "questionType": 8,
- "questionContent": "What is your phone number?",
- "questionAnswer": "my-phone"
}, - {
- "questionType": 9,
- "questionContent": "What is your website address?",
- "questionAnswer": "my-website"
}, - {
- "questionType": 10,
- "questionContent": "What is your birth date?",
- "questionAnswer": "my-birthday"
}
]
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value
.
Also logged in user can see only his own website data (otherwise 403 status code will be received).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
file | string <binary> Represents the content of file |
extensions | string This is optional. Accepted extensions are jpg, png, jpeg |
{- "payload": {
- "fileId": "string"
}
}
No authentication is needed.
supportCenterDomain | string Example: supportCenterDomain=test.com |
{- "payload": {
- "supportCenterUrl": "{SUPPORT_CENTER_URL}",
- "privacyPolicyUrl": "{PRIVACY_POLICY_URL}",
- "imprintUrl": "{IMPRINT_URL}",
- "companyName": "{COMPANY_NAME}",
- "fontName": "{FONT_NAME}",
- "theme": {
- "colors": {
- "primary": "{PRIMARY_COLOR}",
- "secondary": "{SECONDARY_COLOR}",
- "tertiary": "{TERTIARY_COLOR}",
- "positive": "{POSITIVE_COLOR}",
- "negative": "{NEGATIVE_COLOR}",
- "neutral": "{NEUTRAL_COLOR}"
}
}, - "logoUrl": "{LOGO_DATA}",
- "logoAlt": "{LOGO_ALT_TEXT}"
}
}
Get all website visits within a specified time range and organizes them by day. Also calculates the count of visits for a previous period with the same duration. The results are sorted by day and consider the specified timezone for the data
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
page | integer Example: page=1 Page to be requested |
pageSize | integer Example: pageSize=20 Number of items per page to be requested |
referrerUrl | string Example: referrerUrl=https://google.com the url of the referrer page |
pageViewUrl | string Example: pageViewUrl=https://google.com the url of the page |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
},
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "totalCurrent": 200,
- "totalPrevious": 199,
- "current": [
- {
- "value": 100,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 100,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 101,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 98,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "totalCurrent": 200,
- "totalPrevious": 199,
- "current": [
- {
- "value": 100,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 100,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 101,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 98,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "totalCurrent": 200,
- "totalPrevious": 199,
- "current": [
- {
- "value": 100,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 100,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 101,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 98,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "totalCurrent": 200,
- "totalPrevious": 199,
- "current": [
- {
- "value": 100,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 100,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 101,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 98,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "totalCurrent": 200,
- "totalPrevious": 199,
- "current": [
- {
- "value": 100,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 100,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 101,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 98,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "totalCurrent": 200,
- "totalPrevious": 199,
- "current": [
- {
- "value": 100,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 100,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 101,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 98,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "totalCurrent": 200,
- "totalPrevious": 199,
- "current": [
- {
- "value": 100,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 100,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 101,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 98,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "totalCurrent": 200,
- "totalPrevious": 199,
- "current": [
- {
- "value": 100,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 100,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 101,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 98,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "totalCurrent": 199.99,
- "totalPrevious": 199.99,
- "current": [
- {
- "value": 100,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 99.99,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 99.9,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 100.09,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "totalCurrent": 199.99,
- "totalPrevious": 199.99,
- "current": [
- {
- "value": 100,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 99.99,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 99.9,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 100.09,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "totalCurrent": 199.99,
- "totalPrevious": 199.99,
- "current": [
- {
- "value": 100,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 99.99,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 99.9,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 100.09,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "totalCurrent": 199.99,
- "totalPrevious": 199.99,
- "current": [
- {
- "value": 100,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 99.99,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 99.9,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 100.09,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "totalCurrent": 199.99,
- "totalPrevious": 199.99,
- "current": [
- {
- "value": 100,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 99.99,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 99.9,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 100.09,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "totalCurrent": 199.99,
- "totalPrevious": 199.99,
- "current": [
- {
- "value": 100,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 99.99,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 99.9,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 100.09,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "totalCurrent": 199.99,
- "totalPrevious": 199.99,
- "current": [
- {
- "value": 100,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 99.99,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 99.9,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 100.09,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "totalCurrent": 199.99,
- "totalPrevious": 199.99,
- "current": [
- {
- "value": 100,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 99.99,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 99.9,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 100.09,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
items | integer Example: items=10 items |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
[- {
- "itemId": "uuid",
- "itemName": "Product 1",
- "payload": {
- "totalCurrent": 22.22,
- "totalPrevious": 22.22,
- "current": [
- {
- "value": 0,
- "from": "string",
- "until": "string"
}
], - "previous": [
- {
- "value": 0,
- "from": "string",
- "until": "string"
}
]
}
}
]
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
items | integer Example: items=10 items |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
[- {
- "itemId": "uuid",
- "itemName": "Product 1",
- "payload": {
- "totalCurrent": 22.22,
- "totalPrevious": 22.22,
- "current": [
- {
- "value": 0,
- "from": "string",
- "until": "string"
}
], - "previous": [
- {
- "value": 0,
- "from": "string",
- "until": "string"
}
]
}
}
]
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
items | integer Example: items=10 items |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
[- {
- "itemId": "uuid",
- "itemName": "Product 1",
- "payload": {
- "totalCurrent": 22,
- "totalPrevious": 22,
- "current": [
- {
- "value": 0,
- "from": "string",
- "until": "string"
}
], - "previous": [
- {
- "value": 0,
- "from": "string",
- "until": "string"
}
]
}
}
]
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
items | integer Example: items=10 items |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
[- {
- "itemId": "uuid",
- "itemName": "Product 1",
- "payload": {
- "totalCurrent": 22,
- "totalPrevious": 22,
- "current": [
- {
- "value": 0,
- "from": "string",
- "until": "string"
}
], - "previous": [
- {
- "value": 0,
- "from": "string",
- "until": "string"
}
]
}
}
]
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "totalCurrent": 20,
- "totalPrevious": 20,
- "current": [
- {
- "value": 10,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 10,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 5,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 15,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "totalCurrent": 20,
- "totalPrevious": 20,
- "current": [
- {
- "value": 10,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 10,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 5,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 15,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "totalCurrent": 20,
- "totalPrevious": 20,
- "current": [
- {
- "value": 10,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 10,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 5,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 15,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "totalCurrent": 20,
- "totalPrevious": 20,
- "current": [
- {
- "value": 10,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 10,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "value": 5,
- "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 15,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "current": [
- {
- "points": [
- {
- "channelType": 1,
- "values": [
- {
- "company": "Google",
- "value": 10
}
]
}
], - "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 10,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "points": [
- {
- "channelType": 1,
- "values": [
- {
- "company": "Google",
- "value": 10
}
]
}
], - "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 10,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "current": [
- {
- "points": [
- {
- "channelType": 1,
- "values": [
- {
- "company": "Google",
- "value": 10
}
]
}
], - "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 10,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
], - "previous": [
- {
- "points": [
- {
- "channelType": 1,
- "values": [
- {
- "company": "Google",
- "value": 10
}
]
}
], - "from": "2021-04-18T22:59:59.000Z",
- "until": "2021-04-19T24:59:59.000Z"
}, - {
- "value": 10,
- "from": "2021-04-19T22:59:59.000Z",
- "until": "2021-04-20T24:59:59.000Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "timeframe": {
- "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}, - "pagination": {
- "page": 0,
- "pageSize": 0
}, - "segments": [
- {
- "id": "string",
- "conditions": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
], - "primaryDimension": "string"
}
{- "current": [
- {
- "points": [
- {
- "channelType": 0,
- "values": [
- {
- "company": "string",
- "value": 0
}
]
}
], - "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}
], - "previous": [
- {
- "points": [
- {
- "channelType": 0,
- "values": [
- {
- "company": "string",
- "value": 0
}
]
}
], - "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (ISO8601) Example: from=2018-01-01T00:00:00.000Z Lower bound date filter |
until required | string <date-time> (ISO8601) Example: until=2022-04-18T22:59:59.000Z Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "current": [
- {
- "points": [
- {
- "channelType": 0,
- "values": [
- {
- "company": "string",
- "value": 0
}
]
}
], - "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}
], - "previous": [
- {
- "points": [
- {
- "channelType": 0,
- "values": [
- {
- "company": "string",
- "value": 0
}
]
}
], - "from": "2019-08-24T14:15:22Z",
- "until": "2019-08-24T14:15:22Z"
}
]
}