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 using a user's email and password
string | |
password | string |
{- "email": "test@test.com",
- "password": "test"
}
{- "token": "token-string-value",
- "refreshToken": "token-refresh-string-value",
- "userId": "user-id"
}
A token can be refreshed based on the refreshToken from the create endpoint
refreshToken | string |
{- "refreshToken": "token-refresh-string-value"
}
{- "token": "token-string-value",
- "refreshToken": "token-refresh-string-value",
- "userId": "user-id"
}
A token can be created by using a 3AS INTPC Token that was generated using the 3AS SDK
token | string If token is sent email and password are ignored |
{- "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}
{- "token": "token-string-value",
- "refreshToken": "token-refresh-string-value",
- "clientId": "client-id",
- "companyId": "company-id"
}
Get visits information as graph data
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
type required | string Value: "time-series" Example: type=time-series |
unit required | 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 filtered visits information as graph data
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
type required | string Value: "time-series" Example: type=time-series |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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": {
- "datasets": [
- {
- "label": "Overall Page Visits",
- "data": [
- 32,
- 50,
- 80
]
}
], - "labels": [
- "2022-06-22T15:46:47Z"
]
}
}
Get all website visits with filters
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
previousFrom required | string <date-time> (urlEncodedISO8601) Example: previousFrom=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
previousUntil required | string <date-time> (urlEncodedISO8601) Example: previousUntil=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
group required | string Example: group=page (only group by page option available) Property by which to group the response |
order required | string Enum: "desc" "asc" Example: order=count.asc|desc (only count ordering option) Orders the results from query ascending or descending. |
page required | integer Example: page=1 Page to be requested |
pageSize required | integer Example: pageSize=20 Number of items per page to be requested; maximum number of elements per page is 500 if group=null |
object |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}
}
{- "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 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. |
{- "payload": [
- {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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 | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 from date, default is 7 days ago |
until | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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 visits within a specified time range for a given country code and business sector.
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "payload": {
- "total": 4
}
}
Get all website visitors with filters
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
previousFrom required | string <date-time> (urlEncodedISO8601) Example: previousFrom=2024-06-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter; optional |
previousUntil required | string <date-time> (urlEncodedISO8601) Example: previousUntil=2024-07-10T23%3A59%3A59.000%2B02%3A00 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 required | 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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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": [
- "2023-09-16T00:00:00+02:00"
], - "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
[- {
- "visitorsCount": 134,
- "deviceType": "desktop"
}
]
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
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"
}
[- {
- "visitorsCount": 134,
- "deviceType": "desktop"
}
]
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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": [
- "2023-09-16T00:00:00+02:00"
], - "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
limit | integer Example: limit=10 limit |
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 |
aggr required | string Example: by-country | by-city aggregate by country or city, default is by country |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
start required | integer Example: start=6 Start of the results from query. |
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",
- "sessionKey": "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "payload": {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "payload": {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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 visits within a specified time range for a given country code and business sector.
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "payload": {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "payload": {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "payload": {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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 website visitors within a specified time range for a given country code and business sector.
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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"
]
}
{- "payload": {
- "result": [
- [
- "chrome",
- 45
], - [
- "firefox",
- 32
], - [
- "safari",
- 52
]
]
}
}
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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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 OS within a specified time range for a given country code and business sector.
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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"
]
}
{- "payload": {
- "result": [
- [
- "linux",
- 32
], - [
- "macos",
- 0
], - [
- "windows",
- 130
]
]
}
}
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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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 device within a specified time range for a given country code and business sector.
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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"
]
}
{- "payload": {
- "result": [
- [
- "desktop",
- 166
], - [
- "phone",
- 0
]
]
}
}
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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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
]
]
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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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": [
- "1280x1024",
- "1920x1200",
- "2560x1440"
]
}
{- "payload": {
- "result": [
- [
- "1280x1024",
- 166
], - [
- "1920x1200",
- 20
], - [
- "2560x1440",
- 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).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter (default = until - 7 days) |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter (default = today's date) |
previousFrom | string <date-time> (urlEncodedISO8601) Example: previousFrom=2024-06-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter; optional |
previousUntil | string <date-time> (urlEncodedISO8601) Example: previousUntil=2024-07-10T23%3A59%3A59.000%2B02%3A00 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 required | 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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "payload": {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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 |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}
}
{- "payload": {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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 |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-08-09T23%3A59%3A59.999%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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 |
Array of objects Example: order=visitorStatus.asc,unixTs.desc,countryCode.asc,ip.desc,companyOrgName.asc,device.desc,platform.asc,browser.desc,pageVisitsInSession.asc,hasRecording.desc Orders the results from query by name in ascending or descending order. | |
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 |
onlySsrSessions | string |
object | |
object | |
alarmingEvents | Array of strings (Alarming Events) Items Enum: "deadClicks" "rageClicks" "mouseMoves" "scrolls" "uTurns" "reloads" |
{- "containsPage": "string",
- "notContainsPage": "string",
- "country": {
- "is": "string",
- "isNot": "string"
}, - "devices": [
- "string"
], - "os": {
- "is": "string",
- "isNot": "string"
}, - "browser": {
- "is": "string",
- "isNot": "string"
}, - "status": [
- 0
], - "onlySsrSessions": "true",
- "ip": {
- "contains": "string",
- "notContains": "string"
}, - "companyName": {
- "contains": "string",
- "notContains": "string"
}, - "alarmingEvents": [
- "deadClicks"
]
}
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "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,
- "alarmingEvents": [
- "deadClicks"
]
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
limit required | integer Example: limit=10 limit |
[- {
- "sessionKey": "valid-uuid",
- "lat": 51.0328,
- "long": 7.0524,
- "ip": "78.47.153.144",
- "visitorKey": "fp_955b8d6c494da9d80099da003a24f1ce",
- "privacyLevel": "0"
}
]
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
limit required | integer Example: limit=10 limit |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- "string"
]
}
]
}, - "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": [
- {
- "sessionKey": "valid-uuid",
- "lat": 51.0328,
- "long": 7.0524,
- "ip": "78.47.153.144",
- "visitorKey": "fp_955b8d6c494da9d80099da003a24f1ce",
- "privacyLevel": "0"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
object | |
object |
{- "filter": {
- "from": "2024-01-01T00:00:00.000+07:00",
- "until": "2024-01-01T00:00:00.000+07:00"
}, - "update": {
- "seen": true,
- "star": true
}
}
[- {
- "key": "string",
- "websiteKey": "string",
- "sessionKey": "string",
- "seen": true,
- "star": true,
- "comment": "string"
}
]
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-08-09T23%3A59%3A59.999%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter. |
start | integer Example: start=6 Start of the results from query. |
length | integer Length of the results from query. |
order | string Enum: "desc" "asc" Orders the results from query ascending or descending. |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
starred | string |
watched | string |
note | string |
from | number <int64> |
until | number <int64> |
object | |
object | |
object | |
object | |
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 | |
recordingId | string |
alarmingEvents | Array of strings (Alarming Events) Items Enum: "deadClicks" "rageClicks" "mouseMoves" "scrolls" "uTurns" "reloads" |
{- "starred": "string",
- "watched": "string",
- "note": "string",
- "from": 0,
- "until": 0,
- "country": {
- "is": [
- "string"
], - "isNot": [
- "string"
]
}, - "os": {
- "is": [
- "string"
], - "isNot": [
- "string"
]
}, - "browser": {
- "is": [
- "string"
], - "isNot": [
- "string"
]
}, - "devices": {
- "is": [
- "string"
], - "isNot": [
- "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"
}, - "recordingId": "string",
- "alarmingEvents": [
- "deadClicks"
]
}
{- "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",
- "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"
}, - "events": {
- "events": 0,
- "moveInteractions": 0,
- "scrollInteractions": 0,
- "clickInteractions": 0,
- "incSnapshots": 0
}, - "alarmingEvents": {
- "deadClicks": 0,
- "rageClicks": 0,
- "mouseMoves": 0,
- "scrolls": 0,
- "uTurns": 0,
- "reloads": 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. |
{- "payload": {
- "average-duration": 0
}
}
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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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 Traffic Structure Field Values
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
trafficType required | string Type of traffic |
[- "string"
]
Get Traffic Structure Field Values V2
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
trafficType required | string Type of traffic |
{- "payload": [
- "string"
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}, - "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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 |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
{- "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}, - "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}, - "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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 |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
{- "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}, - "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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": {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "payload": {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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"
}
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12,
- 13
]
]
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12,
- 13
]
]
}
]
}
}
In regards to the visitor data, the endpoint returns the number of unique overall visitors, new visitors, and returning visitors in a given period of time.
This endpoint calculates unique visitors based on the previous visits made by a visitor before the specified period.
The period is determined by the start and end timestamps provided in the request query parameters.
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": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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,
- "averageVisitDuration": 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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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"
}
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12,
- 13
]
], - "total": 25.3,
- "totalAverage": 12.6
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12,
- 13
]
], - "total": 25.3,
- "totalAverage": 12.6
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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"
}
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12,
- 13
]
], - "total": 25.3,
- "totalAverage": 12.6
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12,
- 13
]
], - "total": 25.3,
- "totalAverage": 12.6
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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"
}
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12,
- 13
]
], - "total": 25.3,
- "totalAverage": 12.6
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12,
- 13
]
], - "total": 25.3,
- "totalAverage": 12.6
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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"
}
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12,
- 13
]
], - "total": 25.3,
- "totalAverage": 12.6
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12,
- 13
]
], - "total": 25.3,
- "totalAverage": 12.6
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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"
}
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
], - "total": 25.3,
- "totalAverage": 12.6
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
], - "total": 25.3,
- "totalAverage": 12.6
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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"
}
{- "payload": {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "payload": {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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"
}
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
], - "total": 25.3,
- "totalAverage": 12.6
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
], - "total": 25.3,
- "totalAverage": 12.6
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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"
}
{- "payload": {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "payload": {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object |
{- "payload": {
- "data": 79.12
}
}
{- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "payload": {
- "data": 79.12
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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"
}
{- "payload": {
- "data": 79.12
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "payload": {
- "data": 79.12
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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"
}
{- "payload": {
- "data": 79.12,
- "info": "string"
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "payload": {
- "data": 79.12,
- "info": "string"
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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"
}
{- "payload": {
- "data": 79.12,
- "info": "string"
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "payload": {
- "data": 79.12,
- "info": "string"
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
limit required | integer Example: limit=10 limit |
start required | integer Example: start=6 Start of the results from query. |
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": {
- "countItems": 2,
- "total": 2,
- "items": [
- {
- "id": "00000000-0000-0000-0000-000000000000",
- "name": "Product 1",
- "variant": "Variant 1",
- "data": 2
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
limit required | integer Example: limit=10 limit |
start required | integer Example: start=6 Start of the results from query. |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "payload": {
- "countItems": 2,
- "total": 2,
- "items": [
- {
- "id": "00000000-0000-0000-0000-000000000000",
- "name": "Product 1",
- "variant": "Variant 1",
- "data": 2
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
limit required | integer Example: limit=10 limit |
start required | integer Example: start=6 Start of the results from query. |
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": {
- "countItems": 2,
- "total": 2,
- "items": [
- {
- "id": "00000000-0000-0000-0000-000000000000",
- "name": "Product 1",
- "variant": "Variant 1",
- "data": 2
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
limit required | integer Example: limit=10 limit |
start required | integer Example: start=6 Start of the results from query. |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "payload": {
- "countItems": 2,
- "total": 2,
- "items": [
- {
- "id": "00000000-0000-0000-0000-000000000000",
- "name": "Product 1",
- "variant": "Variant 1",
- "data": 2
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
limit required | integer Example: limit=10 limit |
start required | integer Example: start=6 Start of the results from query. |
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": {
- "countItems": 2,
- "total": 2,
- "items": [
- {
- "id": "00000000-0000-0000-0000-000000000000",
- "name": "Product 1",
- "variant": "Variant 1",
- "data": 2
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
limit required | integer Example: limit=10 limit |
start required | integer Example: start=6 Start of the results from query. |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "payload": {
- "countItems": 2,
- "total": 2,
- "items": [
- {
- "id": "00000000-0000-0000-0000-000000000000",
- "name": "Product 1",
- "variant": "Variant 1",
- "data": 2
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
limit required | integer Example: limit=10 limit |
start required | integer Example: start=6 Start of the results from query. |
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": {
- "countItems": 2,
- "total": 2,
- "items": [
- {
- "id": "00000000-0000-0000-0000-000000000000",
- "name": "Product 1",
- "variant": "Variant 1",
- "data": 2
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
limit required | integer Example: limit=10 limit |
start required | integer Example: start=6 Start of the results from query. |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "payload": {
- "countItems": 2,
- "total": 2,
- "items": [
- {
- "id": "00000000-0000-0000-0000-000000000000",
- "name": "Product 1",
- "variant": "Variant 1",
- "data": 2
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
limit required | integer Example: limit=10 limit |
start required | integer Example: start=6 Start of the results from query. |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "payload": [
- {
- "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 Start of the results from query. |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": [
- {
- "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 Start of the results from query. |
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. |
{- "payload": {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
limit required | integer Example: limit=10 limit |
start required | integer Example: start=6 Start of the results from query. |
itemName | string Example: "Product 1" Default is "Product 1" |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "payload": [
- {
- "id": "uuid",
- "name": "Product 1"
}
], - "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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"
}
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
], - "total": 25.3,
- "totalAverage": 12.6,
- "itemId": "uuid-uuid-uuid-uuid"
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
], - "total": 25.3,
- "totalAverage": 12.6,
- "itemId": "uuid-uuid-uuid-uuid"
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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"
}
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
], - "total": 25.3,
- "totalAverage": 12.6,
- "itemId": "uuid-uuid-uuid-uuid"
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
], - "total": 25.3,
- "totalAverage": 12.6,
- "itemId": "uuid-uuid-uuid-uuid"
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
limit required | integer Example: limit=10 limit |
start required | integer Example: start=6 Start of the results from query. |
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. |
{- "payload": {
- "count": 2,
- "items": [
- {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
limit required | integer Example: limit=10 limit |
start required | integer Example: start=6 Start of the results from query. |
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": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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": {
- "count": 2,
- "items": [
- {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
limit | integer Example: limit=10 limit |
start | integer Example: start=6 Start of the results from query. |
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. |
{- "payload": {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
limit | integer Example: limit=10 limit |
start | integer Example: start=6 Start of the results from query. |
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": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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": {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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"
}
{- "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12,
- 13
]
]
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12,
- 13
]
]
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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"
}
{- "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12,
- 13
]
]
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12,
- 13
]
]
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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": {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "payload": {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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"
}
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12,
- 13
]
]
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12,
- 13
]
]
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
limit required | integer Example: limit=10 limit |
start required | integer Example: start=6 Start of the results from query. |
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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
limit required | integer Example: limit=10 limit |
start required | integer Example: start=6 Start of the results from query. |
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": [
]
}
]
}
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 |
view required | string Enum: "item" "type" Example: view=item Must be either "item" or "type". |
page | integer Example: page=1 Page to be requested |
pageSize | integer Example: pageSize=20 Number of items per page to be requested |
search | string Example: search=button Text to search for. Returns most similar results based on ngram score. |
{- "data": [
- {
- "itemId": "prod_01HJ121FHEVZD39MNasdasd2adasJ8VSN",
- "itemName": "Camera lens"
}, - {
- "itemId": "prod_01HNJH8JMGH6WX7950VRGR7WSJ",
- "itemName": "Medusa Shorts 234234234"
}, - {
- "itemId": "prod_01HNJHBS14PQAVTTQF8NTSFAX3",
- "itemName": "dualshock4"
}
], - "page": 1,
- "pageSize": 10
}
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 required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
type required | string Value: "time-series" Example: type=time-series |
unit required | 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 filtered visits information as graph data
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
type required | string Value: "time-series" Example: type=time-series |
unit required | string Enum: "day" "week" "month" "year" Example: unit=day |
object | |
Array of objects | |
object | |
object | |
Array of objects | |
primaryDimension | string optional |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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": {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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> (urlEncodedISO8601) Example: from=2024-08-09T23%3A59%3A59.999%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter. |
start | integer Example: start=6 Start of the results from query. |
length | integer Length of the results from query. |
order | string Enum: "desc" "asc" Orders the results from query ascending or descending. |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
starred | string |
watched | string |
note | string |
from | number <int64> |
until | number <int64> |
object | |
object | |
object | |
object | |
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 | |
recordingId | string |
alarmingEvents | Array of strings (Alarming Events) Items Enum: "deadClicks" "rageClicks" "mouseMoves" "scrolls" "uTurns" "reloads" |
{- "starred": "string",
- "watched": "string",
- "note": "string",
- "from": 0,
- "until": 0,
- "country": {
- "is": [
- "string"
], - "isNot": [
- "string"
]
}, - "os": {
- "is": [
- "string"
], - "isNot": [
- "string"
]
}, - "browser": {
- "is": [
- "string"
], - "isNot": [
- "string"
]
}, - "devices": {
- "is": [
- "string"
], - "isNot": [
- "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"
}, - "recordingId": "string",
- "alarmingEvents": [
- "deadClicks"
]
}
{- "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",
- "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"
}, - "events": {
- "events": 0,
- "moveInteractions": 0,
- "scrollInteractions": 0,
- "clickInteractions": 0,
- "incSnapshots": 0
}, - "alarmingEvents": {
- "deadClicks": 0,
- "rageClicks": 0,
- "mouseMoves": 0,
- "scrolls": 0,
- "uTurns": 0,
- "reloads": 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. |
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"
}
]
}
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 |
sessionId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a session |
{- "payload": [
- {
- "trigger": "deadClicks",
- "triggerValue": 10,
- "start": 1664345317,
- "end": 1664345317
}
], - "meta": {
- "total": 30
}
}
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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter (default = until - 7 days) |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter (default = today's date) |
page | integer Example: page=1 Page to be requested |
pageSize | integer Example: pageSize=20 Number of items per page to be requested |
{- "payload": [
- [
- "desktop",
- 27244,
- 0.16617520909285868
]
], - "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}
}
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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter (default = until - 7 days) |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter (default = today's date) |
page | integer Example: page=1 Page to be requested |
pageSize | integer Example: pageSize=20 Number of items per page to be requested |
{- "payload": [
- [
- "chrome",
- 7244,
- 0.16617520909285868
]
], - "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}
}
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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter (default = until - 7 days) |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter (default = today's date) |
page | integer Example: page=1 Page to be requested |
pageSize | integer Example: pageSize=20 Number of items per page to be requested |
{- "payload": [
- [
- "iOS",
- 21969,
- 0.16617520909285868
]
], - "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}
}
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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter (default = until - 7 days) |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter (default = today's date) |
page | integer Example: page=1 Page to be requested |
pageSize | integer Example: pageSize=20 Number of items per page to be requested |
{- "payload": [
- [
- "864x640",
- 19431,
- 0.16617520909285868
]
], - "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}
}
(DEPRECATED) 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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter (default = until - 7 days) |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter (default = today's date) |
previousFrom required | string <date-time> (urlEncodedISO8601) Example: previousFrom=2024-06-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter; optional |
previousUntil required | string <date-time> (urlEncodedISO8601) Example: previousUntil=2024-07-10T23%3A59%3A59.000%2B02%3A00 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 required | 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
}
]
}
(DEPRECATED) 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 required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter (default = until - 7 days) |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter (default = today's date) |
previousFrom required | string <date-time> (urlEncodedISO8601) Example: previousFrom=2024-06-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter; optional |
previousUntil required | string <date-time> (urlEncodedISO8601) Example: previousUntil=2024-07-10T23%3A59%3A59.000%2B02%3A00 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 |
{- "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 |
funnelId required | string Funnel ID |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter (default = until - 7 days) |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter (default = today's date) |
previousFrom required | string <date-time> (urlEncodedISO8601) Example: previousFrom=2024-06-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter; optional |
previousUntil required | string <date-time> (urlEncodedISO8601) Example: previousUntil=2024-07-10T23%3A59%3A59.000%2B02%3A00 Upper bound date filter; optional |
status | string Enum: "draft" "published" 0 = pending or draft status, 1 = active status, 2 = limit reached status |
object |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
{- "payload": [
- {
- "id": "funnel-123456",
- "name": "Homepage to External Link Funnel",
- "createdAt": 1628097600000,
- "updatedAt": 1694822400000,
- "createdBy": "user-abc123",
- "levels": [
- {
- "kind": "page",
- "name": "Homepage",
- "data": {
- "urlPattern": null,
- "customEvent": null,
- "autoEvent": null,
- "outgoingTraffic": null,
- "ecomEvent": null,
- "alarmingEvent": null
}
}, - {
- "kind": "outgoing_traffic",
- "name": "Click to Partner Site",
- "data": {
- "websitePage": null,
- "urlPattern": null,
- "customEvent": null,
- "autoEvent": null,
- "ecomEvent": null,
- "alarmingEvent": null
}
}
], - "status": "published",
- "expectedConversionRate": 25,
- "visitorCountInTimeRange": 5000,
- "visitorCountInPreviousTimeRange": 4500,
- "conversionRate": 18.6,
- "previousConversionRate": 16.2,
- "currentConversion": 930,
- "previousConversion": 729,
- "levelsConversionData": [
- {
- "totalVisitors": 5000,
- "dropoutsVisitors": 1200,
- "conversionRate": 76,
- "dropoutsRate": 24
}, - {
- "totalVisitors": 3800,
- "dropoutsVisitors": 2870,
- "conversionRate": 24.5,
- "dropoutsRate": 75.5
}
]
}, - {
- "id": "funnel-789012",
- "name": "Signup Funnel",
- "createdAt": 1628184000000,
- "updatedAt": 1694908800000,
- "createdBy": "user-abc123",
- "levels": [
- {
- "kind": "website_page",
- "name": "Landing Page",
- "data": {
- "urlPattern": null,
- "customEvent": null,
- "autoEvent": null,
- "outgoingTraffic": null,
- "ecomEvent": null,
- "alarmingEvent": null
}
}, - {
- "kind": "website_page",
- "name": "Signup Page",
- "data": {
- "urlPattern": null,
- "customEvent": null,
- "autoEvent": null,
- "outgoingTraffic": null,
- "ecomEvent": null,
- "alarmingEvent": null
}
}
], - "status": "published",
- "expectedConversionRate": 30,
- "visitorCountInTimeRange": 3500,
- "visitorCountInPreviousTimeRange": 3200,
- "conversionRate": 22.8,
- "previousConversionRate": 20.1,
- "currentConversion": 798,
- "previousConversion": 643,
- "levelsConversionData": [
- {
- "totalVisitors": 3500,
- "dropoutsVisitors": 700,
- "conversionRate": 80,
- "dropoutsRate": 20
}, - {
- "totalVisitors": 2800,
- "dropoutsVisitors": 2002,
- "conversionRate": 28.5,
- "dropoutsRate": 71.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).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
funnelId required | string Funnel ID |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter (default = until - 7 days) |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter (default = today's date) |
previousFrom required | string <date-time> (urlEncodedISO8601) Example: previousFrom=2024-06-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter; optional |
previousUntil required | string <date-time> (urlEncodedISO8601) Example: previousUntil=2024-07-10T23%3A59%3A59.000%2B02%3A00 Upper bound date filter; optional |
object |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
{- "payload": {
- "FunnelWithOutgoingTrafficAndPageURL": {
- "value": {
- "payload": {
- "id": "funnel-123456",
- "name": "Homepage to External Link Funnel",
- "createdAt": 1628097600000,
- "updatedAt": 1694822400000,
- "createdBy": "user-abc123",
- "levels": [
- {
- "kind": "website_page",
- "name": "Homepage",
- "data": {
- "urlPattern": null,
- "customEvent": null,
- "autoEvent": null,
- "outgoingTraffic": null,
- "ecomEvent": null,
- "alarmingEvent": null
}
}, - {
- "kind": "outgoing_traffic",
- "name": "Click to Partner Site",
- "data": {
- "websitePage": null,
- "urlPattern": null,
- "customEvent": null,
- "autoEvent": null,
- "ecomEvent": null,
- "alarmingEvent": null
}
}
], - "status": "published",
- "expectedConversionRate": 25,
- "visitorCountInTimeRange": 5000,
- "visitorCountInPreviousTimeRange": 4500,
- "conversionRate": 18.6,
- "previousConversionRate": 16.2,
- "currentConversion": 930,
- "previousConversion": 729,
- "levelsConversionData": [
- {
- "totalVisitors": 5000,
- "dropoutsVisitors": 1200,
- "conversionRate": 76,
- "dropoutsRate": 24
}, - {
- "totalVisitors": 3800,
- "dropoutsVisitors": 2870,
- "conversionRate": 24.5,
- "dropoutsRate": 75.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).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
view required | string Enum: "label" "category" "action" "value" Example: view=label Must be either "label" or "category" or "action" or "value". |
page | integer Example: page=1 Page to be requested |
pageSize | integer Example: pageSize=20 Number of items per page to be requested |
search | string Example: search=button Text to search for. Returns most similar results based on ngram score. |
type | string Enum: "custom" "auto" Example: type=auto Type of custom event, can be custom or auto. |
{- "data": [
- "button",
- "Test which listeners are are active on the button",
- "Create new button ",
- "Dead Click Button",
- "radiobutton",
- "new button"
], - "page": 1,
- "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 |
view required | string Enum: "item" "type" Example: view=item Must be either "item" or "type". |
page | integer Example: page=1 Page to be requested |
pageSize | integer Example: pageSize=20 Number of items per page to be requested |
search | string Example: search=button Text to search for. Returns most similar results based on ngram score. |
{- "data": [
- {
- "itemId": "prod_01HJ121FHEVZD39MNasdasd2adasJ8VSN",
- "itemName": "Camera lens"
}, - {
- "itemId": "prod_01HNJH8JMGH6WX7950VRGR7WSJ",
- "itemName": "Medusa Shorts 234234234"
}, - {
- "itemId": "prod_01HNJHBS14PQAVTTQF8NTSFAX3",
- "itemName": "dualshock4"
}
], - "page": 1,
- "pageSize": 10
}
websiteKey required | string |
createdBy | string or null |
expectedConversionRate | integer or null <int32> [ 0 .. 100 ] |
required | Array of objects or null (FunnelLevelItem) |
name required | string |
status required | string Enum: "published" "draft" |
{- "createdBy": "string",
- "expectedConversionRate": 100,
- "levels": [
- {
- "data": {
- "alarmingEvent": {
- "type": [
- "string"
]
}, - "autoEvent": {
- "action": "string",
- "category": "string",
- "label": "string",
- "triggerURLs": [
- "string"
], - "value": "string"
}, - "customEvent": {
- "action": "string",
- "bindingBrowserAction": "string",
- "category": "string",
- "fieldsObject": "string",
- "label": "string",
- "triggerURLs": [
- "string"
], - "value": "string"
}, - "ecomEvent": {
- "itemIDs": [
- "string"
], - "triggerURLs": [
- "string"
], - "type": [
- "string"
]
}, - "outgoingTraffic": {
- "url": "string"
}, - "urlPattern": {
- "match": "simple",
- "url": "string"
}, - "websitePage": {
- "type": "static",
- "url": "string"
}
}, - "kind": "website_page",
- "name": "string"
}
], - "name": "string",
- "status": "published"
}
{- "meta": {
- "page": 0,
- "pageSize": 0,
- "pageTotal": 0,
- "total": 0
}, - "payload": {
- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "expectedConversionRate": 0,
- "id": "string",
- "levels": [
- {
- "data": {
- "alarmingEvent": {
- "type": [
- "string"
]
}, - "autoEvent": {
- "action": "string",
- "category": "string",
- "label": "string",
- "triggerURLs": [
- "string"
], - "value": "string"
}, - "customEvent": {
- "action": "string",
- "bindingBrowserAction": "string",
- "category": "string",
- "fieldsObject": "string",
- "label": "string",
- "triggerURLs": [
- "string"
], - "value": "string"
}, - "ecomEvent": {
- "itemIDs": [
- "string"
], - "triggerURLs": [
- "string"
], - "type": [
- "string"
]
}, - "outgoingTraffic": {
- "url": "string"
}, - "urlPattern": {
- "match": "simple",
- "url": "string"
}, - "websitePage": {
- "type": "static",
- "url": "string"
}
}, - "kind": "string",
- "name": "string"
}
], - "name": "string",
- "status": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "websiteKey": "string"
}
}
websiteKey required | string |
funnelId required | string |
expectedConversionRate | integer or null <int32> [ 0 .. 100 ] |
name | string or null |
status | string or null Enum: "published" "draft" |
{- "expectedConversionRate": 100,
- "name": "string",
- "status": "published"
}
{- "meta": {
- "page": 0,
- "pageSize": 0,
- "pageTotal": 0,
- "total": 0
}, - "payload": {
- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "expectedConversionRate": 0,
- "id": "string",
- "levels": [
- {
- "data": {
- "alarmingEvent": {
- "type": [
- "string"
]
}, - "autoEvent": {
- "action": "string",
- "category": "string",
- "label": "string",
- "triggerURLs": [
- "string"
], - "value": "string"
}, - "customEvent": {
- "action": "string",
- "bindingBrowserAction": "string",
- "category": "string",
- "fieldsObject": "string",
- "label": "string",
- "triggerURLs": [
- "string"
], - "value": "string"
}, - "ecomEvent": {
- "itemIDs": [
- "string"
], - "triggerURLs": [
- "string"
], - "type": [
- "string"
]
}, - "outgoingTraffic": {
- "url": "string"
}, - "urlPattern": {
- "match": "simple",
- "url": "string"
}, - "websitePage": {
- "type": "static",
- "url": "string"
}
}, - "kind": "string",
- "name": "string"
}
], - "name": "string",
- "status": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "websiteKey": "string"
}
}
websiteKey required | string |
funnelId required | string |
{- "detail": "Property foo is required but is missing.",
- "errors": [
- {
- "location": "string",
- "message": "string",
- "value": null
}
], - "status": 400,
- "title": "Bad Request",
}
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> (urlEncodedISO8601) Example: from=2024-08-09T23%3A59%3A59.999%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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 |
filterNameParam | string filter name param |
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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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' |
{- "items": [
- {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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' |
[- {
- "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 |
{- "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"
}
"OK"
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 |
"OK"
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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
}
}
]
}
]
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
}
{- "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 |
{- "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 | integer <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 | integer <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).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
{- "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).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
{- "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).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
{- "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).
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": {
- "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).
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": {
- "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
}
{- "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 |
{- "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 | integer <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. Poll questions and appearance will always be included in the 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} |
string Current page url. Needs to be a valid url. Used to decide if poll should be displayed | |
string Visitor key. Used to decide if poll should be displayed |
{- "payload": {
- "id": "string-id",
- "createdAt": 1664345317,
- "title": "My first poll",
- "language": "en",
- "logoId": "id-string",
- "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",
- "bubblePosition": 1,
- "hPadding": 10,
- "vPadding": 10
}
}
}
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).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
{- "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).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
{- "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).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
{- "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).
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": {
- "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).
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": {
- "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).
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} |
page | integer Example: page=1 Page to be requested |
pageSize | integer Example: pageSize=20 Number of items per page to be requested |
{- "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).
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} |
page | integer Example: page=1 Page to be requested |
pageSize | integer Example: pageSize=20 Number of items per page to be requested |
object | |
object |
{- "visitor": {
- "is": [
- "all"
], - "isNot": [
- "new"
]
}, - "location": {
- "is": [
- "DE",
- "FR"
], - "isNot": [
- "RO",
- "FR"
]
}
}
{- "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).
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} |
visitorId required | string ID of a visitor. Pattern is [-\w.]+ |
{- "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"
}
]
}
}
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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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> (urlEncodedISO8601) Example: from=2024-08-09T23%3A59%3A59.999%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "payload": {
- "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> (urlEncodedISO8601) Example: from=2024-08-09T23%3A59%3A59.999%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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 |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}
}
{- "payload": {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "payload": {
- "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> (urlEncodedISO8601) Example: from=2024-08-09T23%3A59%3A59.999%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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 |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}
}
{- "payload": {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "payload": {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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 |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}
}
{- "payload": {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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
]
]
}
]
}
Operations about notification settings for standard reports (daily/weekly/monthly)
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": {
- "websiteKey": "string-id",
- "emailList": [
- {
- "value": "email@address.com",
- "verified": true
}
], - "reportType": 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).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
reportType | string |
{- "reportType": "1"
}
{- "payload": {
- "websiteKey": "string-id",
- "emailList": [
- {
- "value": "email@address.com",
- "verified": true
}
], - "reportType": 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).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
string Email Address To Remove From Notification Settings |
{- "email": "email3@address.com"
}
{- "payload": {
- "websiteKey": "string-id",
- "emailList": [
- {
- "value": "email@address.com",
- "verified": true
}
], - "reportType": 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).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
string New Email Address Added to Notification Settings |
{- "email": "email3@address.com"
}
{- "payload": {
- "websiteKey": "string-id",
- "emailList": [
- {
- "value": "email3@address.com",
- "verified": false
}
], - "reportType": 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).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
string | |
token | string |
{- "email": "email3@address.com",
- "token": "valid-jwt-token"
}
{ }
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 |
string |
{- "email": "email3@address.com"
}
{- "payload": {
- "websiteKey": "string-id",
- "emailList": [
- {
- "value": "email3@address.com",
- "verified": true
}
], - "reportType": 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).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
{- "payload": {
- "websiteKey": "string-id",
- "abeEmailList": [
- {
- "value": "email@address.com",
- "verified": true
}
], - "abeActivated": true,
- "abeWebsiteErrorsThreshold": {
- "limit": 30,
- "interval": 25
}, - "abeNegativeEventsThreshold": {
- "limit": 25,
- "interval": 25
}
}
}
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 |
abeActivated | boolean optional |
object optional | |
object optional |
{- "abeActivated": true,
- "abeWebsiteErrorsThreshold": {
- "limit": 30,
- "interval": 25
}, - "abeNegativeEventsThreshold": {
- "limit": 25,
- "interval": 25
}
}
{- "payload": {
- "websiteKey": "string-id",
- "abeEmailList": [
- {
- "value": "email@address.com",
- "verified": true
}
], - "abeActivated": true,
- "abeWebsiteErrorsThreshold": {
- "limit": 30,
- "interval": 25
}, - "abeNegativeEventsThreshold": {
- "limit": 25,
- "interval": 25
}
}
}
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 |
string Email Address To Remove From ABE Notification Settings |
{- "email": "email3@address.com"
}
{- "payload": {
- "websiteKey": "string-id",
- "abeEmailList": [
- {
- "value": "email@address.com",
- "verified": true
}
], - "abeActivated": true,
- "abeWebsiteErrorsThreshold": {
- "limit": 30,
- "interval": 25
}, - "abeNegativeEventsThreshold": {
- "limit": 25,
- "interval": 25
}
}
}
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 |
string New Email Address Added to ABE Notification Settings |
{- "email": "email3@address.com"
}
{- "payload": {
- "websiteKey": "string-id",
- "abeEmailList": [
- {
- "value": "email3@address.com",
- "verified": true
}
], - "abeActivated": true,
- "abeWebsiteErrorsThreshold": {
- "limit": 30,
- "interval": 25
}, - "abeNegativeEventsThreshold": {
- "limit": 25,
- "interval": 25
}
}
}
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 |
string | |
token | string |
{- "email": "email3@address.com",
- "token": "valid-jwt-token"
}
{ }
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 |
string |
{- "email": "email3@address.com"
}
{- "payload": {
- "websiteKey": "string-id",
- "abeEmailList": [
- {
- "value": "email@address.com",
- "verified": true
}
], - "abeActivated": true,
- "abeWebsiteErrorsThreshold": {
- "limit": 30,
- "interval": 25
}, - "abeNegativeEventsThreshold": {
- "limit": 25,
- "interval": 25
}
}
}
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 |
{- "url": "string",
- "numberOfMonthlyVisits": 0,
- "numberOfDashboardAccesses": 0,
- "latestDashboardAccesses": [ ],
- "frontendFlags": {
- "trackingCodeInstalled": true,
- "trackingCodeIsInstalledChangedAt": 0,
- "acceptedSsr": true,
- "0-92816": true,
- "lastACmodalViewedAt": 0,
- "0-100720": true,
- "0-100820": true,
- "recordingsSettings": true
}, - "metaSiteId": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "hasFirstLogin": true,
- "timezone": "string",
- "lastResetDate": 0,
- "resetDataRequested": 0,
- "migrationStatus": null,
- "lastVisitTs": 0,
- "isPayable": true,
- "hadFirstVisit": true,
- "installDate": 0,
- "lastInstallDate": 0,
- "anonymizeIps": true,
- "consentlessTracking": true,
- "maxPrivacyMode": true,
- "eventTracking": true,
- "eventAutoTracking": true,
- "ignoreVisitsKey": "string",
- "appDate": null,
- "status": "string",
- "platform": "string",
- "country": "string",
- "firstWeekDay": 0,
- "locale": "string",
- "currency": "string",
- "companyName": "string",
- "businessSector": 0,
- "businessSize": "string",
- "findUs": "string",
- "street": "string",
- "zipcode": "string",
- "city": "string",
- "state": "string",
- "vat": "string",
- "ipCountryISO": "string",
- "crawlerStatus": {
- "lastSuccess": 0,
- "last": { }
}
}
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 |
url | string website url |
string website email | |
firstName | string first name string |
lastName | string last name string |
timezone | string websites timezone |
object | |
metaSiteId | string meta site id from WIX |
anonymizeIps | boolean true, if anonymize ips were set - DEPRECATED |
consentlessTracking | boolean true, if consentless tracking was set |
maxPrivacyMode | boolean true, if user chooses to max privacy mode - DEPRECATED |
eventTracking | boolean true, if user chooses to track events |
eventAutoTracking | boolean if user chooses the event auto tracking option for this website |
country | string websites country |
firstWeekDay | integer first week day chosen for this website |
locale | string websites locale |
currency | string websites currency; default EUR |
company | string company name for the website |
businessSector | integer business sector chosen for the website |
businessSize | string business size chosen for the website |
findUs | string response for "how did you find us?" |
street | string street name |
zipCode | string valid zipcode |
city | string businesses address |
state | string businesses address |
vat | string vat identification |
{- "url": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "timezone": "string",
- "frontendFlags": {
- "trackingCodeInstalled": true,
- "trackingCodeIsInstalledChangedAt": 0,
- "acceptedSsr": true,
- "0-92816": true,
- "lastACmodalViewedAt": 0,
- "0-100720": true,
- "0-100820": true,
- "recordingsSettings": true
}, - "metaSiteId": "string",
- "anonymizeIps": true,
- "consentlessTracking": true,
- "maxPrivacyMode": true,
- "eventTracking": true,
- "eventAutoTracking": true,
- "country": "string",
- "firstWeekDay": 0,
- "locale": "string",
- "currency": "string",
- "company": "string",
- "businessSector": 0,
- "businessSize": "string",
- "findUs": "string",
- "street": "string",
- "zipCode": "string",
- "city": "string",
- "state": "string",
- "vat": "string"
}
{- "url": "string",
- "numberOfMonthlyVisits": 0,
- "numberOfDashboardAccesses": 0,
- "latestDashboardAccesses": [ ],
- "frontendFlags": {
- "trackingCodeInstalled": true,
- "trackingCodeIsInstalledChangedAt": 0,
- "acceptedSsr": true,
- "0-92816": true,
- "lastACmodalViewedAt": 0,
- "0-100720": true,
- "0-100820": true,
- "recordingsSettings": true
}, - "metaSiteId": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "hasFirstLogin": true,
- "timezone": "string",
- "lastResetDate": 0,
- "resetDataRequested": 0,
- "migrationStatus": null,
- "lastVisitTs": 0,
- "isPayable": true,
- "hadFirstVisit": true,
- "installDate": 0,
- "lastInstallDate": 0,
- "anonymizeIps": true,
- "consentlessTracking": true,
- "maxPrivacyMode": true,
- "eventTracking": true,
- "eventAutoTracking": true,
- "ignoreVisitsKey": "string",
- "appDate": null,
- "status": "string",
- "platform": "string",
- "country": "string",
- "firstWeekDay": 0,
- "locale": "string",
- "currency": "string",
- "companyName": "string",
- "businessSector": 0,
- "businessSize": "string",
- "findUs": "string",
- "street": "string",
- "zipcode": "string",
- "city": "string",
- "state": "string",
- "vat": "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 |
{- "visits": {
- "limit": 100000
}, - "recordings": {
- "limit": 15
}, - "heatmaps": {
- "limit": 2
}, - "funnels": {
- "limit": 2
}, - "polls": {
- "limit": 2
}, - "surveys": {
- "limit": 2
}, - "isPayable": true,
- "ip2company": false,
- "visitorSegments": false,
- "customDashboard": false,
- "countryBasedPrivacy": false,
- "feedbackAdvertising": false,
- "wixCycleType": 3,
- "wixPermissionPack": 1,
- "unlimitedVoucher": null
}
Authentication is not needed. Unsubscribe the website from report or abe report or from newsletter list or al of them for provided email
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
email required | string Provided value is removed from listmonk |
reportsDisableNotification | boolean When is true, the email value is removed from report's email list |
abeReportsDisableNotification | boolean When is true, the email value is removed from abe report's email list |
{- "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 |
productId | string Represents the wix plan id |
billingCycle | string Represents the plan's billing cycle. Only accepts "MONTHLY" or "YEARLY" |
country | string (optional) Website's country code |
{- "productId": "12342",
- "billingCycle": "MONTHLY",
- "country": "DE"
}
{- "redirectUrl": "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 |
sumoLimit | int Provided value is optional, can be null or integer |
{- "monthly": {
- "0": {
- "name": "Basic",
- "price": 12.99,
- "type": "monthly",
- "oldPlanIds": [ ],
- "weight": 200,
- "active": true,
- "order": 1,
- "pageScanLimit": 7776000,
- "key_service": 24395,
- "key_service_unique": "Basic",
- "permissions": [
- {
- "n": "VISITS_LIMIT",
- "value": 500000
}, - {
- "n": "SSR_LIMIT",
- "value": 50000
}, - {
- "n": "HEATMAPS_LIMIT",
- "value": 25
}, - {
- "n": "FUNNELS_LIMIT",
- "value": 16
}, - {
- "n": "POLLS_LIMIT",
- "value": 7
}, - {
- "n": "SURVEYS_LIMIT",
- "value": 7
}, - {
- "n": "EVENT_TRACKING_LIMIT",
- "value": 100
}
], - "id": "24395"
}
}, - "yearly": {
- "0": {
- "name": "Basic",
- "price": 12.99,
- "type": "yearly",
- "oldPlanIds": [ ],
- "weight": 200,
- "active": true,
- "order": 1,
- "pageScanLimit": 7776000,
- "key_service": 24395,
- "key_service_unique": "Basic",
- "permissions": [
- {
- "n": "VISITS_LIMIT",
- "value": 500000
}, - {
- "n": "SSR_LIMIT",
- "value": 50000
}, - {
- "n": "HEATMAPS_LIMIT",
- "value": 25
}, - {
- "n": "FUNNELS_LIMIT",
- "value": 16
}, - {
- "n": "POLLS_LIMIT",
- "value": 7
}, - {
- "n": "SURVEYS_LIMIT",
- "value": 7
}, - {
- "n": "EVENT_TRACKING_LIMIT",
- "value": 100
}
], - "id": "24396"
}
}
}
{- "monthly": {
- "0": {
- "name": "Advanced",
- "id": "premiumPackage2",
- "price": 12.99,
- "type": "wix",
- "availabilty": "18250 days",
- "flag": "w2m",
- "oldPlanIds": [ ],
- "weight": 200,
- "active": true,
- "pageScanLimit": 7776000,
- "permissions": [
- {
- "n": "VISITS_LIMIT",
- "value": 50000
}, - {
- "n": "SSR_LIMIT",
- "value": 5000
}, - {
- "n": "HEATMAPS_LIMIT",
- "value": 10
}, - {
- "n": "FUNNELS_LIMIT",
- "value": 4
}, - {
- "n": "POLLS_LIMIT",
- "value": 4
}, - {
- "n": "SURVEYS_LIMIT",
- "value": 4
}, - {
- "n": "EVENT_TRACKING_LIMIT",
- "value": 100
}, - {
- "n": "FULL_DATA_HISTORY_ACCESS",
- "value": "unlimited"
}, - {
- "n": "ALARMING_BEHAVIOR_EVENTS",
- "value": "unlimited"
}, - {
- "n": "PRIVACY_FRIENDLY_ANALYTICS",
- "value": "unlimited"
}, - {
- "n": "UNLIMITED_EXPORTS",
- "value": "unlimited"
}, - {
- "n": "COMPANY_REVEAL",
- "value": "unavailable"
}, - {
- "n": "VISITOR_SEGMENTS",
- "value": "unavailable"
}, - {
- "n": "UNLIMITED_COLLABORATORS",
- "value": "unavailable"
}, - {
- "n": "CUSTOM_COUNTRY_DATA",
- "value": "unavailable"
}, - {
- "n": "CUSTOM_DASHBOARDS",
- "value": "unavailable"
}, - {
- "n": "UNLIMITED_API_ACCESS",
- "value": "unavailable"
}, - {
- "n": "PREMIUM_SUPPORT",
- "value": "unavailable"
}
]
}
}, - "yearly": {
- "0": {
- "name": "Advanced",
- "id": "premiumPackage2",
- "price": 12.99,
- "type": "wix",
- "availabilty": "18250 days",
- "flag": "w2m",
- "oldPlanIds": [ ],
- "weight": 200,
- "active": true,
- "pageScanLimit": 7776000,
- "permissions": [
- {
- "n": "VISITS_LIMIT",
- "value": 50000
}, - {
- "n": "SSR_LIMIT",
- "value": 5000
}, - {
- "n": "HEATMAPS_LIMIT",
- "value": 10
}, - {
- "n": "FUNNELS_LIMIT",
- "value": 4
}, - {
- "n": "POLLS_LIMIT",
- "value": 4
}, - {
- "n": "SURVEYS_LIMIT",
- "value": 4
}, - {
- "n": "EVENT_TRACKING_LIMIT",
- "value": 100
}, - {
- "n": "FULL_DATA_HISTORY_ACCESS",
- "value": "unlimited"
}, - {
- "n": "ALARMING_BEHAVIOR_EVENTS",
- "value": "unlimited"
}, - {
- "n": "PRIVACY_FRIENDLY_ANALYTICS",
- "value": "unlimited"
}, - {
- "n": "UNLIMITED_EXPORTS",
- "value": "unlimited"
}, - {
- "n": "COMPANY_REVEAL",
- "value": "unavailable"
}, - {
- "n": "VISITOR_SEGMENTS",
- "value": "unavailable"
}, - {
- "n": "UNLIMITED_COLLABORATORS",
- "value": "unavailable"
}, - {
- "n": "CUSTOM_COUNTRY_DATA",
- "value": "unavailable"
}, - {
- "n": "CUSTOM_DASHBOARDS",
- "value": "unavailable"
}, - {
- "n": "UNLIMITED_API_ACCESS",
- "value": "unavailable"
}, - {
- "n": "PREMIUM_SUPPORT",
- "value": "unavailable"
}
]
}
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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"
}
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12,
- 13
]
], - "total": 25.3,
- "totalAverage": 12.6
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12,
- 13
]
], - "total": 25.3,
- "totalAverage": 12.6
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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"
}
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12,
- 13
]
], - "total": 25.3,
- "totalAverage": 12.6
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12,
- 13
]
], - "total": 25.3,
- "totalAverage": 12.6
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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"
}
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12,
- 13
]
], - "total": 25.3,
- "totalAverage": 12.6
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12,
- 13
]
], - "total": 25.3,
- "totalAverage": 12.6
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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"
}
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12,
- 13
]
], - "total": 25.3,
- "totalAverage": 12.6
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12,
- 13
]
], - "total": 25.3,
- "totalAverage": 12.6
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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"
}
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
], - "total": 25.3,
- "totalAverage": 12.6
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
], - "total": 25.3,
- "totalAverage": 12.6
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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"
}
{- "payload": {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "payload": {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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"
}
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
], - "total": 25.3,
- "totalAverage": 12.6
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
], - "total": 25.3,
- "totalAverage": 12.6
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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"
}
{- "payload": {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "payload": {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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"
}
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
], - "total": 25.3,
- "totalAverage": 12.6,
- "itemId": "uuid-uuid-uuid-uuid"
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
], - "total": 25.3,
- "totalAverage": 12.6,
- "itemId": "uuid-uuid-uuid-uuid"
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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"
}
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
], - "total": 25.3,
- "totalAverage": 12.6,
- "itemId": "uuid-uuid-uuid-uuid"
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
], - "total": 25.3,
- "totalAverage": 12.6,
- "itemId": "uuid-uuid-uuid-uuid"
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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"
}
{- "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12,
- 13
]
]
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12,
- 13
]
]
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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"
}
{- "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12,
- 13
]
]
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12,
- 13
]
]
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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": {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "payload": {
- "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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": [
- {
- "type": "string",
- "category": [
- "string"
]
}
]
}
]
}, - "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"
}
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12,
- 13
]
]
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}, - "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12,
- 13
]
]
}
]
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-08-09T23%3A59%3A59.999%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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 |
group required | string Enum: "trigger" "page" Example: group=trigger Groups the results |
Array of objects Example: order=count.asc,percentOfTotal.desc,percentage_change.desc Orders the results from query by name in ascending or descending order. | |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object | |
Array of objects | |
object |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}, - "order": [
- {
- "member": "string",
- "direction": "string",
- "priority": 0
}
], - "pagination": {
- "page": 0,
- "pageSize": 0
}
}
{- "payload": [
- {
- "trigger": "deadClicks",
- "count": 10,
- "percentOfTotal": 40.35,
- "firstAppearance": 1664345317,
- "lastAppearance": 1664345317,
- "previousCount": 5,
- "changeInPercentage": 35.35
}
], - "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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 |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
{- "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}, - "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}, - "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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 |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
{- "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}, - "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 Upper bound date filter |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
{- "payload": {
- "deadClicks": 10,
- "rageClicks": 10,
- "rapidReloads": 10,
- "uTurns": 10,
- "scrolls": 10,
- "mouseMoves": 10
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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 |
object |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
{- "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}, - "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}, - "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> (urlEncodedISO8601) Example: from=2024-08-09T23%3A59%3A59.999%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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 |
timezone | string Timezone of the user. |
order required | string Enum: "desc" "asc" Example: order=adCampaignLabel.desc,numVisits.asc,visitors.desc,maxVisits.asc Orders the results from query ascending or descending. |
X-Timezone | string Timezone of the user. |
object |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
{- "payload": [
- {
- "campaignKey": "string",
- "campaignName": "string",
- "firstVisit": 0,
- "visitors": 0,
- "previousVisitors": 0,
- "visits": 0,
- "previousVisits": 0,
- "topDate": {
- "date": 0,
- "visits": 0
}, - "topVisitedPages": [
- {
- "url": "string",
- "visits": 0
}
], - "topVisitorsCountries": [
- {
- "country": "string",
- "visits": 0
}
]
}
], - "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> (urlEncodedISO8601) Example: from=2024-08-09T23%3A59%3A59.999%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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 |
timezone | string Timezone of the user. |
order required | string Enum: "desc" "asc" Example: order=adCampaignLabel.desc,numVisits.asc,visitors.desc,maxVisits.asc Orders the results from query ascending or descending. |
X-Timezone | string Timezone of the user. |
{- "payload": [
- {
- "campaignKey": "string",
- "campaignName": "string",
- "firstVisit": 0,
- "visitors": 0,
- "previousVisitors": 0,
- "visits": 0,
- "previousVisits": 0,
- "topDate": {
- "date": 0,
- "visits": 0
}, - "topVisitedPages": [
- {
- "url": "string",
- "visits": 0
}
], - "topVisitorsCountries": [
- {
- "country": "string",
- "visits": 0
}
]
}
], - "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
campaignId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a UTM campaign |
{- "payload": {
- "adCampaignLabel": "string"
}, - "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
campaignId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a UTM campaign |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-08-09T23%3A59%3A59.999%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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 |
timezone | string Timezone of the user. |
order required | string Enum: "desc" "asc" Example: order=adCampaignContent.asc,adCampaignTerm.desc,adCampaignMedium.asc,adCampaignSource.asc,adCampaignSourcePlatform.desc,adCampaignCreativeFormat.asc,adCampaignMarketingTactic.desc,newVisitors.asc,returningVisitors.asc,sessions.asc,numVisits.asc,averageSessionDuration.desc,averageBounceRate.asc Orders the results from query ascending or descending. |
X-Timezone | string Timezone of the user. |
object |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- { }
]
}
]
}
}
{- "payload": [
- {
- "adCampaignSource": "string",
- "adCampaignMedium": "string",
- "adCampaignTerm": "string",
- "adCampaignContent": "string",
- "adCampaignSourcePlatform": "string",
- "adCampaignCreativeFormat": "string",
- "adCampaignMarketingTactic": "string",
- "newVisitors": 0,
- "previousNewVisitors": 0,
- "returningVisitors": 0,
- "previousReturningVisitors": 0,
- "visits": 0,
- "previousVisits": 0,
- "sessions": 0,
- "previousSessions": 0,
- "averageSessionDuration": 0,
- "previousAverageSessionDuration": 0,
- "averageBounceRate": 0,
- "previousAverageBounceRate": 0
}
], - "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
campaignId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a UTM campaign |
from required | string <date-time> (urlEncodedISO8601) Example: from=2024-08-09T23%3A59%3A59.999%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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 |
timezone | string Timezone of the user. |
order required | string Enum: "desc" "asc" Example: order=adCampaignContent.asc,adCampaignTerm.desc,adCampaignMedium.asc,adCampaignSource.asc,adCampaignSourcePlatform.desc,adCampaignCreativeFormat.asc,adCampaignMarketingTactic.desc,newVisitors.asc,returningVisitors.asc,sessions.asc,numVisits.asc,averageSessionDuration.desc,averageBounceRate.asc Orders the results from query ascending or descending. |
X-Timezone | string Timezone of the user. |
{- "payload": [
- {
- "adCampaignSource": "string",
- "adCampaignMedium": "string",
- "adCampaignTerm": "string",
- "adCampaignContent": "string",
- "adCampaignSourcePlatform": "string",
- "adCampaignCreativeFormat": "string",
- "adCampaignMarketingTactic": "string",
- "newVisitors": 0,
- "previousNewVisitors": 0,
- "returningVisitors": 0,
- "previousReturningVisitors": 0,
- "visits": 0,
- "previousVisits": 0,
- "sessions": 0,
- "previousSessions": 0,
- "averageSessionDuration": 0,
- "previousAverageSessionDuration": 0,
- "averageBounceRate": 0,
- "previousAverageBounceRate": 0
}
], - "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> (urlEncodedISO8601) Example: from=2024-08-09T23%3A59%3A59.999%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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 |
Array of objects Example: order=outgoingUrl.asc,outgoingUrl.desc,count.desc,count.asc,percentage.desc,percentage.asc Orders the results from query by name in ascending or descending order. | |
timezone | string Timezone of the user. |
X-Timezone | string Timezone of the user. |
object |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- "outgoingUrl",
- "count",
- "percentage",
- "pageUrl",
- "pageTitle",
- "deviceType",
- "ip"
]
}
]
}
}
{- "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> (urlEncodedISO8601) Example: from=2024-08-09T23%3A59%3A59.999%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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 |
Array of objects Example: order=outgoingUrl.asc,outgoingUrl.desc,count.desc,count.asc,percentage.desc,percentage.asc Orders the results from query by name in ascending or descending order. | |
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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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 |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- "outgoingUrl",
- "count",
- "percentage",
- "pageUrl",
- "pageTitle",
- "deviceType",
- "ip"
]
}
]
}
}
{- "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}, - "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}, - "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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. |
{- "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}, - "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> (urlEncodedISO8601) Example: from=2024-07-11T00%3A00%3A00.000%2B02%3A00 Lower bound date filter |
until required | string <date-time> (urlEncodedISO8601) Example: until=2024-08-09T23%3A59%3A59.999%2B02%3A00 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 |
{- "where": {
- "and": [
- {
- "member": "string",
- "operator": "string",
- "values": [
- "url",
- "browserName",
- "browserVersion",
- "countryName",
- "countryCode",
- "cityName",
- "cityCode",
- "deviceType",
- "platform",
- "ip",
- "display",
- "companyOrgName",
- "companyOrgType",
- "adCampaignKey",
- "adCampaignSource",
- "adCampaignMedium",
- "adCampaignContent",
- "adCampaignLabel",
- "adCampaignTerm",
- "adCampaignSourcePlatform",
- "adCampaignCreativeFormat",
- "adCampaignMarketingTactic"
]
}
]
}
}
{- "payload": {
- "labels": [
- "2022-06-22T15:46:47Z",
- "2022-06-22T16:46:47Z"
], - "datasets": [
- {
- "label": "label",
- "data": [
- [
- 12.1,
- 13.2
]
]
}
]
}, - "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}
}
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 |
{
}
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 |
domain | string |
{
}
{- "payload": [ ]
}
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 |
domain required | string Example: http://test.domain.com domain name |
{- "payload": [ ]
}
ids | Array of strings |
{- "ids": [
- "string"
]
}
{- "data": {
- "deletedSegments": [
- "string"
], - "notDeletedSegments": [
- "string"
]
}
}
Authentication is not needed for this action.
url required | string Provided value is the white label custom url |
{- "id": "0ce50df9-a3eb-11e9-8366-0242ag130009",
- "logoId": "5f883b2c019dd00bc52a4a75",
- "logoAlt": "Logo alt text",
- "theme": {
- "id": "580dc492-5c86-11ea-a39f-0242ac320003",
- "name": "Custom theme",
- "colors": {
- "primary": "#000000",
- "secondary": "#000FFF",
- "tertiary": "#000FFF",
- "positive": "#FFFFFF",
- "negative": "#FFFFFF",
- "neutral": "#FFFFFF"
}, - "createdAt": "2021-07-05T10:48:09+00:00"
}, - "fontName": "Arial",
- "replyToEmailAddress": "agency@email.com",
- "createdAt": "2021-07-05T10:48:09+00:00",
- "agencyLegalLinks": [
- {
- "link": "www.agency-privacy.com",
- "type": 2
}
], - "agencyId": "0ce50df9-a3eb-11e9-8366-0242ag130008",
- "companyName": "Company Name"
}
The result is ordered alphabetically by page url.
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
start | integer Example: start=6 Start of the results from query. |
length | integer Length of the results from query. |
search[general] | string Default: "" Example: search[general]=cart Search value for page title and url. Case insensitive. |
{- "PageTotal": 1,
- "pageItems": [
- {
- "key": "9ac7271497030891babf60123d16c861",
- "url": "example.com/test",
- "title": "Test Pages",
- "visits": 408
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
name | string Name of the dynamic page |
pattern | string Pattern of the dynamic page. Use for starts with: "starts_with_string*", for ends with: "*ends_with_string", for contains: "*contains_string*" |
{- "name": "Thank You Dynamic Page",
- "pattern": "*/thank-you"
}
{- "key": "67e14edb2e2ac2.43921585",
- "pattern": "*/thank-you",
- "name": "Thank You Dynamic Page"
}
List of website's dynamic pages
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
[- {
- "key": "67e14edb2e2ac2.43921585",
- "pattern": "*/thank-you",
- "name": "Thank You Dynamic Page"
}
]
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
dynamicPageId required | string Example: 67e14edb2e2ac2.43921585 ID of website's dynamic page. |
name | string Name of the dynamic page |
pattern | string Pattern of the dynamic page. Use for starts with: "starts_with_string*", for ends with: "*ends_with_string", for contains: "*contains_string*" |
{- "name": "Edited Thank You Dynamic Page",
- "pattern": "*/thank-you-too*"
}
{- "key": "67e14edb2e2ac2.43921585",
- "name": "Edited Thank You Dynamic Page",
- "pattern": "*/thank-you-too*"
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
dynamicPageId required | string Example: 67e14edb2e2ac2.43921585 ID of website's dynamic page. |
{- "error": "NOT_FOUND_WEBSITE"
}
API access can also be done using API Keys. This method of authentication with the APIs, allows the user to integrate other products and services with the Twipla APIs and allow them to use only the resources required. Users can tailor integrations to their specific needs, enabling them to access personalized data or services.
The number of API Key that can be created, varies depending on the subscription type.
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value. A logged in user can see/edit/delete data only for his own or shared website (otherwise 403 status code will be received).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
x-user-id required | string <uuid> (uuid) Example: 1b59a188-91ed-4aeb-83ba-92d053fcb27e User ID who owns the API Key |
name | string The name of the API Key. The length of the name must be between 3 and 100 characters. This parameter is required. |
scopes | Array of strings Scope IDs of the scopes that will be added to the API Key. Use the get Scopes endpoint to get the list of scopes. |
scopeGroups | Array of strings Scope Group IDs of the scope groups that will be added to the API Key. Use the get Scope Groups endpoint to get the list of scope groups. |
permissions | Array of strings Permission IDs of the permissions that will be added to the API Key. These permissions, are part of the Scopes and Scope Groups. |
comment | string Comment describing the API Key. |
expiresAt | string <date-time> Expiration date for the API Key. This parameter is required. |
{- "name": "DashboardApiKey",
- "scopes": [
- "0f936483-d0c7-4f4d-ac7a-25f716162824"
], - "scopeGroups": [
- "52f9638c-d767-437b-a72e-e63c288f264d"
], - "permissions": [
- "45411d92-bb5a-473b-8f80-8dafd000d81b"
], - "comment": "Dashboard API Key",
- "expiresAt": "2019-08-24T14:15:22Z"
}
{- "payload": {
- "id": "1b59a188-91ed-4aeb-83ba-92d053fcb27e",
- "name": "DashboardApiKey",
- "apiKey": "twpl-Y8fgb3MqnrjSt6I5FTwn",
- "comment": "Dashboard API Key",
- "createdAt": "2019-08-24T14:15:22Z",
- "expiresAt": "2019-08-24T14:15:22Z"
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value. A logged in user can see/edit/delete data only for his own or shared website (otherwise 403 status code will be received).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
x-user-id required | string <uuid> (uuid) Example: 1b59a188-91ed-4aeb-83ba-92d053fcb27e User ID who owns the API Key |
object | |
Array of objects | |
object |
{- "where": {
- "and": [
- {
- "member": "name",
- "operator": "in",
- "values": "DashboardApiKey"
}
]
}, - "order": [
- {
- "member": "name",
- "direction": "ASC"
}
], - "pagination": {
- "page": 1,
- "pageSize": 10
}
}
{- "payload": {
- "id": "1b59a188-91ed-4aeb-83ba-92d053fcb27e",
- "name": "DashboardApiKey",
- "userId": "01cb9c05-9426-4d83-a0b3-0a032456d4cc",
- "websiteId": "85e33d70-6ccc-4e71-a4db-6fa62445265f",
- "status": "active",
- "comment": "active",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "meta": {
- "page": 1,
- "pageSize": 10,
- "total": 30,
- "pageTotal": 9
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value. A logged in user can see/edit/delete data only for his own or shared website (otherwise 403 status code will be received).
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
apiKeyId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 API key ID |
x-user-id required | string <uuid> (uuid) Example: 1b59a188-91ed-4aeb-83ba-92d053fcb27e User ID who owns the API Key |
{- "payload": {
- "id": "1b59a188-91ed-4aeb-83ba-92d053fcb27e",
- "name": "string",
- "userId": "01cb9c05-9426-4d83-a0b3-0a032456d4cc",
- "websiteId": "85e33d70-6ccc-4e71-a4db-6fa62445265f",
- "status": "active",
- "comment": "Dashboard API Key",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
apiKeyId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 API key ID |
x-user-id required | string <uuid> (uuid) Example: 1b59a188-91ed-4aeb-83ba-92d053fcb27e User ID who owns the API Key |
{- "error": {
- "code": "server_error",
- "details": {
- "fields": [
- {
- "name": "page",
- "message": "cannot parse param",
- "messageI18n": ""
}
]
}
}
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value. A logged in user can see/edit/delete data only for his own or shared website (otherwise 403 status code will be received).
A scope is a group of permissions related to a specific resource (ex. can contain create and read permissions for a specific resource). A permission, can belong to a single scope.
{- "payload": [
- {
- "id": "0f936483-d0c7-4f4d-ac7a-25f716162824",
- "Name": "DashboardApiKey",
- "DisplayName": "DashboardApiKey",
- "Description": "DashboardApiKey used to dashboard APIs",
- "Permissions": [
- {
- "id": "1b59a188-91ed-4aeb-83ba-92d053fcb27e",
- "Name": "dashboardRead",
- "DisplayName": "Dashboard Read",
- "Description": "Permission to read data from the dashboard",
- "ScopeID": "0f936483-d0c7-4f4d-ac7a-25f716162824",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value. A logged in user can see/edit/delete data only for his own or shared website (otherwise 403 status code will be received).
A scope group is a group of permissions not necessarily related to a single resource. A permission, can belong to multiple scope groups.
{- "payload": [
- {
- "id": "52f9638c-d767-437b-a72e-e63c288f264d",
- "Name": "ecomScopeGroup",
- "DisplayName": "Ecom scope group",
- "Description": "This scope group offers access to multiple ecom scopes.",
- "Permissions": [
- {
- "id": "1b59a188-91ed-4aeb-83ba-92d053fcb27e",
- "Name": "dashboardRead",
- "DisplayName": "Dashboard Read",
- "Description": "Permission to read data from the dashboard",
- "ScopeID": "0f936483-d0c7-4f4d-ac7a-25f716162824",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}
Authentication is needed. For that, the request should have authorization header Authorization:Bearer token-string-value. A logged in user can see/edit/delete data only for his own or shared website (otherwise 403 status code will be received).
apiKey | string Use the create API Key endpoint to create an API Key. |
websiteId | string |
{- "apiKey": "twpl-Y8fgb3MqnrjSt6I5FTwn",
- "websiteId": "1b59a188-91ed-4aeb-83ba-92d053fcb27e"
}
{- "payload": {
- "valid": true,
- "data": {
- "userId": "1b59a188-91ed-4aeb-83ba-92d053fcb27e",
- "websiteId": "1b59a188-91ed-4aeb-83ba-92d053fcb27e"
}
}
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
{- "key": "string",
- "websiteKey": "string",
- "paused": false,
- "clickAndScroll": true,
- "textObfuscation": false,
- "minDuration": 0,
- "anyPage": false,
- "pageKeys": [
- "9ac7271497030891babf60123d16c861"
], - "pages": [
- {
- "key": "9ac7271497030891babf60123d16c861",
- "url": "example.com/test",
- "title": "Test Pages"
}
], - "dynamicPageKeys": [
- "67e14edb2e2ac2.43921585"
], - "dynamicPages": [
- {
- "key": "67e14edb2e2ac2.43921585",
- "pattern": "*/thank-you",
- "name": "Thank You Pages"
}
], - "urlPatterns": [
- {
- "url": "example.com/check-out",
- "type": "EXACT"
}
]
}
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
recordingSettingsId required | string Example: 66601d8591d9a4.04194934 ID of website's session recording settings. Pattern is [-\w.]+. Use get Recording Settings endpoint to obtain this id. |
paused | boolean True if recording should be paused, false if recording should be activated |
clickAndScroll | boolean True when should record sessions with activity; false when should record all sessions |
textObfuscation | boolean Default: false True when all text elements (apart from placeholders) should be obfuscated inside a recording |
minDuration | integer <int64> Default: 0 Minimum duration of a session before it is recorded (in seconds) |
anyPage | boolean True when any page should be recorded; false when only pages in pageKeys, dynamicPagekeys and urlPatterns should be recorded |
pageKeys | Array of strings List of page keys which should be recorded. Use get Pages endpoint to get the list of pages. |
dynamicPageKeys | Array of strings List of dynamic page keys which should be recorded. Use get Dynamic Pages endpoint to get the list of dynamic pages. |
Array of objects List of url patterns which should be recorded |
{- "paused": false,
- "clickAndScroll": true,
- "textObfuscation": false,
- "minDuration": 0,
- "anyPage": false,
- "pageKeys": [
- "9ac7271497030891babf60123d16c861"
], - "dynamicPageKeys": [
- "67e14edb2e2ac2.43921585"
], - "urlPatterns": [
- {
- "url": "example.com/check-out",
- "type": "EXACT"
}
]
}
{- "key": "string",
- "websiteKey": "string",
- "paused": false,
- "clickAndScroll": true,
- "textObfuscation": false,
- "minDuration": 0,
- "anyPage": false,
- "pageKeys": [
- "9ac7271497030891babf60123d16c861"
], - "pages": [
- {
- "key": "9ac7271497030891babf60123d16c861",
- "url": "example.com/test",
- "title": "Test Pages"
}
], - "dynamicPageKeys": [
- "67e14edb2e2ac2.43921585"
], - "dynamicPages": [
- {
- "key": "67e14edb2e2ac2.43921585",
- "pattern": "*/thank-you",
- "name": "Thank You Pages"
}
], - "urlPatterns": [
- {
- "url": "example.com/check-out",
- "type": "EXACT"
}
]
}
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 |
view required | string Enum: "label" "category" "action" "value" Example: view=label Must be either "label" or "category" or "action" or "value". |
page | integer Example: page=1 Page to be requested |
pageSize | integer Example: pageSize=20 Number of items per page to be requested |
search | string Example: search=button Text to search for. Returns most similar results based on ngram score. |
type | string Enum: "custom" "auto" Example: type=auto Type of custom event, can be custom or auto. |
{- "data": [
- "button",
- "Test which listeners are are active on the button",
- "Create new button ",
- "Dead Click Button",
- "radiobutton",
- "new button"
], - "page": 1,
- "pageSize": 10
}
Creates a Heatmap.
Only one of page, dynamicPage, UrlPattern or tags is required. However, tags can work alongside pages.
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
name required | string The name of the Heatmap |
color | string <color> Hexadecimal color code. If missing, a random color will be assigned |
visitsLimit required | integer Maximum number of visits allowed |
page required | string or null Page URL |
dynamicPage | string or null Dynamic page URL |
object or null (Tags) Key-value pair representing tags | |
object or null (UrlPattern) |
{- "name": "heatmap",
- "color": "#5C04B4",
- "visitsLimit": 2500,
- "page": "example.com",
- "dynamicPage": "dynamic-page-exmaple.com",
- "tags": {
- "key1": "value1",
- "key2": "value2"
}, - "urlPattern": {
- "url": "/your/path",
- "type": "startsWith"
}
}
{- "id": "string",
- "page": "string",
- "dynamicPage": "string",
- "urlPattern": {
- "url": "/your/path",
- "type": "startsWith"
}, - "name": "string",
- "lim": {
- "max": 0,
- "curr": 0
}, - "dsk": {
- "w": 0,
- "h": 0,
- "visits": 0,
- "pen": [
- "string"
], - "ci": { },
- "si": { },
- "mmi": { }
}, - "tab": {
- "w": 0,
- "h": 0,
- "visits": 0,
- "pen": [
- "string"
], - "ci": { },
- "si": { },
- "mmi": { }
}, - "mob": {
- "w": 0,
- "h": 0,
- "visits": 0,
- "pen": [
- "string"
], - "ci": { },
- "si": { },
- "mmi": { }
}, - "sts": "COLLECTING_DATA",
- "websiteId": "string",
- "color": "string",
- "createdBy": "string",
- "updatedBy": "string",
- "tags": {
- "property1": "string",
- "property2": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
List al website heatmaps.
websiteId required | string <uuid> (uuid) Example: 06d99a32-ee11-11eb-830a-0146de130018 ID of a website |
[- {
- "id": "string",
- "name": "string",
- "url": "string",
- "urlPattern": {
- "url": "/your/path",
- "type": "startsWith"
}, - "status": "COLLECTING_DATA",
- "createdAt": "2019-08-24T14:15:22Z",
- "pageViews": {
- "max": 0,
- "curr": 0
}, - "color": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "updatedBy": "string",
- "tags": {
- "property1": "string",
- "property2": "string"
}
}
]