TWIPLA API (Alpha Version - Work in Progress) (V2)

Download OpenAPI specification:Download

TWIPLA Support: api@twipla.com License: Apache 2.0 Terms of Service

Overview

Introduction

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

Pagination

Raw data is always paginated and uses the following 2 parameters: page and pageSize.

Time Filtering

Coming soon

Field Filtering

Coming soon

Grouping

Coming soon

Ordering

Coming soon

Time series

Time series data is useful for displaying in graphs.

Parameters

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

Authentication

Authentication operations

Create Token

A token can be created in two ways:

  1. Using a user's email and password
  2. Using a 3AS INTPC Token that was generated using the 3AS SDK
Request Body schema: application/json
email
string

Not applicable for 3AS

password
string

Not applicable for 3AS

token
string

If token is sent email and password are ignored

Responses

Request samples

Content type
application/json
{
  • "email": "test@test.com",
  • "password": "test",
  • "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Response samples

Content type
application/json
{
  • "token": "token-string-value",
  • "refreshToken": "token-refresh-string-value",
  • "userId": "user-id"
}

Visits

Operations about website visits

Visits

Get all website visits with filters

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter (default = until - 7 days)

until
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter (default = today's date)

previousFrom
string <date-time> (ISO8601)
Example: previousFrom=2018-01-01T00:00:00.000Z

Lower bound date filter; optional

previousUntil
string <date-time> (ISO8601)
Example: previousUntil=2022-04-18T22:59:59.000Z

Upper bound date filter; optional

group
string
Example: group=page (only group by page option available)

Property by which to group the response

order
string
Enum: "desc" "asc"
Example: order=count.asc|desc (only count ordering option)

Orders the results from query ascending or descending.

page
integer
Example: page=1

Page to be requested

pageSize
integer
Example: pageSize=20

Number of items per page to be requested; maximum number of elements per page is 500 if group=null

Responses

Response samples

Content type
application/json
Example
{
  • "payload": [
    ]
}

Visits graph data

Get visits information as graph data

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

type
string
Value: "time-series"
Example: type=time-series
unit
string
Enum: "day" "week" "month" "year"
Example: unit=day

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Visits count

Get all website visits from the current month considering timezone

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Visit charts by period

Get all website visits given a period considering timezone

path Parameters
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.

query Parameters
specificYear
string

Specific year of the results from query.

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
Example
[
  • {
    },
  • {
    }
]

Page Visits Stats

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

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "labels": [
    ],
  • "datasets": [
    ]
}

Page Visits

Get website visits withing a specified time range, filtering by page URL. Calculate the counts of visits for both current and previous time period, organize the results by page and include page titles. Consider timezone for data processing.

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

length
integer

Length of the results from query.

pageUrl
required
string

Page URL of the results from query.

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "pages": [
    ],
  • "total": {
    },
}

Visits by company name

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

from date, default is 7 days ago

until
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

until date, default is today

page
integer
Example: page=1

page number, default is 1

pageSize
integer
Example: pageSize=20

page size, default is 10

unit
string
Enum: "day" "week" "month" "year"
Example: unit=day
Array of objects
Example: order=visits.desc,companyOrgName.asc

order by, default is visits.desc

companyOrgName
string
Example: companyOrgName=Orange

Company name, default returns all companies. Partial values accepted

Responses

Response samples

Content type
application/json
{
  • "payload": [
    ],
  • "meta": {
    }
}

Overview page visits

Count and organize visit data by timestamp, grouping it into time period defined by unit. It fills in missing data points with 0.

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
onlyTotal
boolean

Whether to include only total in the results from query.

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "total": 4
}

Competition Page Visits

Get count for competition website visits within a specified time range for a given country code and business sector.

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

businessSector
required
integer

Business sector of the results from query.

countryCode
required
string
Example: countryCode=US | BR | DE | GB | RO

Country code of the results from query. Length must be 2.

Responses

Response samples

Content type
application/json
{
  • "total": 4
}

Visitors

Operations about website visitors

Visitors

Get all website visitors with filters

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

previousFrom
string <date-time> (ISO8601)
Example: previousFrom=2018-01-01T00:00:00.000Z

Lower bound date filter; optional

previousUntil
string <date-time> (ISO8601)
Example: previousUntil=2022-04-18T22:59:59.000Z

Upper bound date filter; optional

group
string
Enum: "device" "display" "browser" "operatingSystem"

Groups the results by filter. If other string or none is sent, by default the result is grouped by device

order
string
Enum: "desc" "asc"
Example: order=count.asc|desc or by group name: device.desc|asc, browser.desc|asc, display.desc|asc, operatingSystem.desc|asc

Orders the results from query ascending or descending.

page
integer
Example: page=1

Page to be requested

pageSize
integer
Example: pageSize=20

Number of items per page to be requested

Responses

Response samples

Content type
application/json
{
  • "payload": [
    ],
  • "meta": {
    }
}

New visitors graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
type
required
string
Enum: "time-series" "pie" "bar"
Example: type=time-series
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "payload": {
    }
}

New visitors graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
type
required
string
Enum: "time-series" "pie" "bar"
Example: type=time-series
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Returning visitors graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
type
required
string
Enum: "time-series" "pie" "bar"
Example: type=time-series
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Returning visitors graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
type
required
string
Enum: "time-series" "pie" "bar"
Example: type=time-series
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Converting visitors graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
type
required
string
Enum: "time-series" "pie" "bar"
Example: type=time-series
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Converting visitors graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
type
required
string
Enum: "time-series" "pie" "bar"
Example: type=time-series
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Overall Visitors Stats

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "labels": [
    ],
  • "datasets": [
    ]
}

Returning Visitors Stats

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "labels": [
    ],
  • "datasets": [
    ]
}

Unique Visitors Stats

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "labels": [
    ],
  • "datasets": [
    ]
}

Visitors map

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Visitors list

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

start
required
integer
Example: start=6

page

length
required
integer

Length of the results from query.

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "visitsTotal": 0,
  • "data": [
    ]
}

Visitors by Geo

path Parameters
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

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

start
required
integer
Example: start=6

page

length
required
integer

Length of the results from query.

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Live visitors

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "visitors": [
    ]
}

Competition Page Visitors

Get count for competition website visitors within a specified time range for a given country code and business sector.

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

businessSector
required
integer

Business sector of the results from query.

countryCode
required
string
Example: countryCode=US | BR | DE | GB | RO

Country code of the results from query. Length must be 2.

Responses

Response samples

Content type
application/json
{
  • "total": 4
}

Competition Unique Visitors

Get count for unique competition website visitors within a specified time range for a given country code and business sector.

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

businessSector
required
integer

Business sector of the results from query.

countryCode
required
string
Example: countryCode=US | BR | DE | GB | RO

Country code of the results from query. Length must be 2.

Responses

Response samples

Content type
application/json
{
  • "total": 4
}

Get element interactions

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

pageUrl
required
string

Page URL of the results from query.

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Competition

Operations about competition websites

Competition Page Visits

Get count for competition website visits within a specified time range for a given country code and business sector.

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

businessSector
required
integer

Business sector of the results from query.

countryCode
required
string
Example: countryCode=US | BR | DE | GB | RO

Country code of the results from query. Length must be 2.

Responses

Response samples

Content type
application/json
{
  • "total": 4
}

Competition Page Visitors

Get count for competition website visitors within a specified time range for a given country code and business sector.

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

businessSector
required
integer

Business sector of the results from query.

countryCode
required
string
Example: countryCode=US | BR | DE | GB | RO

Country code of the results from query. Length must be 2.

Responses

Response samples

Content type
application/json
{
  • "total": 4
}

Competition Unique Visitors

Get count for unique competition website visitors within a specified time range for a given country code and business sector.

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

businessSector
required
integer

Business sector of the results from query.

countryCode
required
string
Example: countryCode=US | BR | DE | GB | RO

Country code of the results from query. Length must be 2.

Responses

Response samples

Content type
application/json
{
  • "total": 4
}

Competition Browsers

Get count for unique competition website visitors within a specified time range for a given country code and business sector.

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

businessSector
required
integer

Business sector of the results from query.

countryCode
required
string
Example: countryCode=US | BR | DE | GB | RO

Country code of the results from query. Length must be 2.

Request Body schema: application/json
browsers
Array of strings

Responses

Request samples

Content type
application/json
{
  • "browsers": [
    ]
}

Response samples

Content type
application/json
[
  • [
    ],
  • [
    ],
  • [
    ]
]

Competition Operating Systems

Get count for unique competition visits by OS within a specified time range for a given country code and business sector.

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

businessSector
required
integer

Business sector of the results from query.

countryCode
required
string
Example: countryCode=US | BR | DE | GB | RO

Country code of the results from query. Length must be 2.

Request Body schema: application/json
operatingSystems
Array of strings

Responses

Request samples

Content type
application/json
{
  • "operatingSystems": [
    ]
}

Response samples

Content type
application/json
[
  • [
    ],
  • [
    ],
  • [
    ]
]

Competition Devices

Get count for unique competition visits by device within a specified time range for a given country code and business sector.

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

businessSector
required
integer

Business sector of the results from query.

countryCode
required
string
Example: countryCode=US | BR | DE | GB | RO

Country code of the results from query. Length must be 2.

Request Body schema: application/json
devices
Array of strings

Responses

Request samples

Content type
application/json
{
  • "devices": [
    ]
}

Response samples

Content type
application/json
[
  • [
    ],
  • [
    ],
  • [
    ]
]

Competition Screen Sizes

Get count for unique competition visits by screen size within a specified time range for a given country code and business sector.

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

businessSector
required
integer

Business sector of the results from query.

countryCode
required
string
Example: countryCode=US | BR | DE | GB | RO

Country code of the results from query. Length must be 2.

Request Body schema: application/json
screenSizes
Array of strings

Responses

Request samples

Content type
application/json
{
  • "screenSizes": [
    ]
}

Response samples

Content type
application/json
[
  • [
    ],
  • [
    ],
  • [
    ]
]

Sessions

Operations about website sessions

Sessions

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).

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter (default = until - 7 days)

until
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter (default = today's date)

previousFrom
string <date-time> (ISO8601)
Example: previousFrom=2018-01-01T00:00:00.000Z

Lower bound date filter; optional

previousUntil
string <date-time> (ISO8601)
Example: previousUntil=2022-04-18T22:59:59.000Z

Upper bound date filter; optional

group
string
Enum: "country" "landing-page" "page" "referrer"
Example: group=country

Groups the results by filter. No default option is available.

order
string
Enum: "desc" "asc"
Example: order=count.asc,referrer.desc (only for group by referrer)

Orders the results from query ascending or descending.

pageSize
integer
Example: pageSize=20

Number of items per page to be requested; maximum number of elements per page is 500 if group=null

page
integer
Example: page=1

Page to be requested

Responses

Response samples

Content type
application/json
Example
{
  • "payload": [
    ],
  • "meta": {
    }
}

Sessions graph data

Get sessions information as graph data

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
type
required
string
Enum: "time-series" "pie" "bar"
Example: type=time-series
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Sessions graph data

Get sessions information as graph data

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
type
required
string
Enum: "time-series" "pie" "bar"
Example: type=time-series
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Average Session Duration Stats

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "labels": [
    ],
  • "datasets": [
    ]
}

User Sessions Stats

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "labels": [
    ],
  • "datasets": [
    ]
}

Average Session Pages Stats

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "labels": [
    ],
  • "datasets": [
    ]
}

Sessions table

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
containsPage
string
notContainsPage
string
object
devices
Array of strings
object
object
status
Array of integers

Responses

Request samples

Content type
application/json
{
  • "containsPage": "string",
  • "notContainsPage": "string",
  • "country": {
    },
  • "devices": [
    ],
  • "os": {
    },
  • "browser": {
    },
  • "status": [
    ]
}

Response samples

Content type
application/json
{
  • "sessionsTotal": 0,
  • "data": [
    ]
}

Session log

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
sessionId
required
string
Example: sessionId=5f7b1b2b-5b0b-4b0b-8b0b-5b0b1b2b5b0b

Session ID

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Sessions latest

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
limit
integer

Limit number of sessions to return. Default is 6

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "sessionsTotal": 0,
  • "data": [
    ]
}

Heatmap sessions data

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).

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

heatmapId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a heatmap

query Parameters
group
string
Example: group=country

Groups the results by filter. Only group by country option available

order
string
Enum: "desc" "asc"
Example: order=count.asc|desc or country.desc|asc

Orders the results from query ascending or descending.

pageSize
integer
Example: pageSize=20

Number of items per page to be requested

page
integer
Example: page=1

Page to be requested

Responses

Response samples

Content type
application/json
{
  • "payload": [
    ],
  • "meta": {
    }
}

Get average duration

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Get session recordings data

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
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

Responses

Request samples

Content type
application/json
{
  • "starred": "string",
  • "watched": "string",
  • "from": 0,
  • "until": 0,
  • "country": {
    },
  • "os": {
    },
  • "browser": {
    },
  • "devices": [
    ],
  • "status": [
    ],
  • "containsPage": "string",
  • "notContainsPage": "string",
  • "durations": {
    },
  • "pageCount": {
    },
  • "entryPage": "string",
  • "exitPage": "string",
  • "funnelDropouts": {
    },
  • "referrerURLs": [
    ],
  • "trafficChannels": [
    ],
  • "adCampaignLabels": [
    ]
}

Response samples

Content type
application/json
{
  • "sessionsTotal": 0,
  • "data": [
    ]
}

Get session recordings data

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
starred
string
watched
string
from
number <int64>
until
number <int64>
object
object
object
devices
Array of strings
status
Array of integers
containsPage
string
notContainsPage
string
object
object
entryPage
string
exitPage
string
object
referrerURLs
Array of strings
trafficChannels
Array of strings
adCampaignLabels
Array of strings
object

Responses

Request samples

Content type
application/json
{
  • "starred": "string",
  • "watched": "string",
  • "from": 0,
  • "until": 0,
  • "country": {
    },
  • "os": {
    },
  • "browser": {
    },
  • "devices": [
    ],
  • "status": [
    ],
  • "containsPage": "string",
  • "notContainsPage": "string",
  • "durations": {
    },
  • "pageCount": {
    },
  • "entryPage": "string",
  • "exitPage": "string",
  • "funnelDropouts": {
    },
  • "referrerURLs": [
    ],
  • "trafficChannels": [
    ],
  • "adCampaignLabels": [
    ],
  • "tags": {
    }
}

Response samples

Content type
application/json
{
  • "sessionsTotal": 0,
  • "data": [
    ]
}

Traffic Structure

Operations about website traffic structure

Traffic share classification overview

Retrieve and analyze data 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.

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "from": "2019-08-24T14:15:22Z",
  • "until": "2019-08-24T14:15:22Z",
  • "points": [
    ]
}

Traffic share classification overview

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.

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

Responses

Response samples

Content type
application/json
{
  • "from": "2019-08-24T14:15:22Z",
  • "until": "2019-08-24T14:15:22Z",
  • "points": [
    ]
}

Traffic share in depth

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "labels": [
    ],
  • "datasets": [
    ]
}

Traffic share in depth

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "labels": [
    ],
  • "datasets": [
    ]
}

Pages per visits overview

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "overall": 0,
  • "points": [
    ],
  • "from": "2019-08-24T14:15:22Z",
  • "until": "2019-08-24T14:15:22Z"
}

Pages per visits overview

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "overall": 0,
  • "points": [
    ],
  • "from": "2019-08-24T14:15:22Z",
  • "until": "2019-08-24T14:15:22Z"
}

Pages per visits in depth

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "labels": [
    ],
  • "datasets": [
    ]
}

Pages per visit in depth

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "labels": [
    ],
  • "datasets": [
    ]
}

Bounce rate overview

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "overall": 0,
  • "points": [
    ],
  • "from": "2019-08-24T14:15:22Z",
  • "until": "2019-08-24T14:15:22Z"
}

Bounce rate overview

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "overall": 0,
  • "points": [
    ],
  • "from": "2019-08-24T14:15:22Z",
  • "until": "2019-08-24T14:15:22Z"
}

Bounce rate in depth

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "labels": [
    ],
  • "datasets": [
    ]
}

Bounce rate in depth

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "labels": [
    ],
  • "datasets": [
    ]
}

Session duration overview

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "overall": 0,
  • "points": [
    ],
  • "from": "2019-08-24T14:15:22Z",
  • "until": "2019-08-24T14:15:22Z"
}

Session duration overview

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "overall": 0,
  • "points": [
    ],
  • "from": "2019-08-24T14:15:22Z",
  • "until": "2019-08-24T14:15:22Z"
}

Session duration in depth

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "labels": [
    ],
  • "datasets": [
    ]
}

Session duration in depth

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "labels": [
    ],
  • "datasets": [
    ]
}

Field Values

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

trafficType
required
string

Type of traffic

Responses

Response samples

Content type
application/json
[
  • "string"
]

Field Values V2

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

trafficType
required
string

Type of traffic

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get Ecom Traffic Structure Overview

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Traffic Structure Overview

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Traffic Structure In Depth

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Traffic Structure In Depth

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "current": [
    ],
  • "previous": [
    ]
}

Analytics

Operations about website analytics

Page Analytics

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "page": 0,
  • "pageSize": 0,
  • "totalPages": 0,
  • "totalItems": 0,
  • "items": [
    ]
}

Ecom

Operations about website e-commerce

Has ecom events

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day

Responses

Response samples

Content type
application/json
true

Get Ecom Sessions Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "totalCurrent": 200,
  • "totalPrevious": 199,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Sessions Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "totalCurrent": 200,
  • "totalPrevious": 199,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Customers Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "totalCurrent": 200,
  • "totalPrevious": 199,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Customers Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "totalCurrent": 200,
  • "totalPrevious": 199,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Orders Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "totalCurrent": 200,
  • "totalPrevious": 199,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Orders Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "totalCurrent": 200,
  • "totalPrevious": 199,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Sold Products Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "totalCurrent": 200,
  • "totalPrevious": 199,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Sold Products Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "totalCurrent": 200,
  • "totalPrevious": 199,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Gross Revenue Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "totalCurrent": 199.99,
  • "totalPrevious": 199.99,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Gross Revenue Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "totalCurrent": 199.99,
  • "totalPrevious": 199.99,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Net Revenue Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "totalCurrent": 199.99,
  • "totalPrevious": 199.99,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Net Revenue Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "totalCurrent": 199.99,
  • "totalPrevious": 199.99,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Session Purchase Ratio Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "totalCurrent": 199.99,
  • "totalPrevious": 199.99,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Session Purchase Ratio Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "totalCurrent": 199.99,
  • "totalPrevious": 199.99,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Checkout Purchase Ratio Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "totalCurrent": 199.99,
  • "totalPrevious": 199.99,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Checkout Purchase Ratio Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "totalCurrent": 199.99,
  • "totalPrevious": 199.99,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Average Items Order

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "current": 79.12,
  • "previous": 79.12
}

Get Ecom Average Items Order

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "current": 79.12,
  • "previous": 79.12
}

Get Ecom Average Value Order

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "current": 79.12,
  • "previous": 79.12
}

Get Ecom Average Value Order

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "current": 79.12,
  • "previous": 79.12
}

Get Ecom Highest Revenue Day

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "current": 79.12,
  • "currentInfo": "string",
  • "previous": 79.12,
  • "previousInfo": "string"
}

Get Ecom Highest Revenue Day

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "current": 79.12,
  • "currentInfo": "string",
  • "previous": 79.12,
  • "previousInfo": "string"
}

Get Ecom Highest Order Day

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "current": 79.12,
  • "currentInfo": "string",
  • "previous": 79.12,
  • "previousInfo": "string"
}

Get Ecom Highest Order Day

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "current": 79.12,
  • "currentInfo": "string",
  • "previous": 79.12,
  • "previousInfo": "string"
}

Get Ecom Top Sold Products

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

limit
required
integer
Example: limit=10

limit

start
required
integer
Example: start=6

page

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "count": 2,
  • "total": 2,
  • "items": []
}

Get Ecom Top Sold Products

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

limit
required
integer
Example: limit=10

limit

start
required
integer
Example: start=6

page

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "count": 2,
  • "total": 2,
  • "items": []
}

Get Ecom Most Viewed Products

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

limit
required
integer
Example: limit=10

limit

start
required
integer
Example: start=6

page

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "count": 2,
  • "total": 2,
  • "items": []
}

Get Ecom Most Viewed Products

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

limit
required
integer
Example: limit=10

limit

start
required
integer
Example: start=6

page

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "count": 2,
  • "total": 2,
  • "items": []
}

Get Ecom Most Removed From Cart

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

limit
required
integer
Example: limit=10

limit

start
required
integer
Example: start=6

page

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "count": 2,
  • "total": 2,
  • "items": []
}

Get Ecom Most Removed From Cart

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

limit
required
integer
Example: limit=10

limit

start
required
integer
Example: start=6

page

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "count": 2,
  • "total": 2,
  • "items": []
}

Get Ecom Most Added To Cart

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

limit
required
integer
Example: limit=10

limit

start
required
integer
Example: start=6

page

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "count": 2,
  • "total": 2,
  • "items": []
}

Get Ecom Most Added To Cart

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

limit
required
integer
Example: limit=10

limit

start
required
integer
Example: start=6

page

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "count": 2,
  • "total": 2,
  • "items": []
}

Get Ecom Top Customers

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
limit
required
integer
Example: limit=10

limit

start
required
integer
Example: start=6

page

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Ecom Latest Orders

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
limit
required
integer
Example: limit=10

limit

start
required
integer
Example: start=6

page

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Ecom Customers

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
limit
required
integer
Example: limit=10

limit

start
required
integer
Example: start=6

page

order
required
string

Permited values: name, grossRevenue, orderCount Example: name.asc, grossRevenue.desc Default is name.asc

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "count": 1,
  • "countOrders": 1,
  • "grossRevenue": 100.12,
  • "payload": [
    ]
}

Get Ecom Highest Revenue Products

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

limit
required
integer
Example: limit=10

limit

start
required
integer
Example: start=6

page

itemName
string

Example: "Product 1" Default is "Product 1"

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get Ecom Highest Revenue Products

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

limit
required
integer
Example: limit=10

limit

start
required
integer
Example: start=6

page

itemName
string

Example: "Product 1" Default is "Product 1"

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Ecom Revenue By Product

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
items
integer
Example: items=10

items

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get Ecom Revenue By Product

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
items
integer
Example: items=10

items

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Ecom Units Sold By Product

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
items
integer
Example: items=10

items

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get Ecom Units Sold By Product

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
items
integer
Example: items=10

items

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Ecom Viewed Products

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

limit
required
integer
Example: limit=10

limit

start
required
integer
Example: start=6

page

order
required
string

Permited values: itemName, cntSold, sku, cateogry, price, numViews, addToWishlist, addToCart, removeFromCart Example: itemName.asc Default is cntSold.desc

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "count": 1,
  • "payload": [
    ]
}

Get Ecom Viewed Products

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

limit
required
integer
Example: limit=10

limit

start
required
integer
Example: start=6

page

order
required
string

Permited values: itemName, cntSold, sku, cateogry, price, numViews, addToWishlist, addToCart, removeFromCart Example: itemName.asc Default is cntSold.desc

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "count": 1,
  • "payload": [
    ]
}

Get Ecom Product List

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

limit
integer
Example: limit=10

limit

start
integer
Example: start=6

page

order
string

Permited values: itemName, numViews Example: itemName.asc Default is numViews.desc

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "count": 1,
  • "payload": [
    ]
}

Get Ecom Product List

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

limit
integer
Example: limit=10

limit

start
integer
Example: start=6

page

order
string

Permited values: itemName, numViews Example: itemName.asc Default is numViews.desc

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "count": 1,
  • "payload": [
    ]
}

Get Ecom Checkout Initiated Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "totalCurrent": 20,
  • "totalPrevious": 20,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Checkout Initiated Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "totalCurrent": 20,
  • "totalPrevious": 20,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Cart Viewed Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "totalCurrent": 20,
  • "totalPrevious": 20,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Cart Viewed Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "totalCurrent": 20,
  • "totalPrevious": 20,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Traffic Structure Overview

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Traffic Structure Overview

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Traffic Structure In Depth

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Traffic Structure In Depth

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Abandoned Cart

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

limit
required
integer
Example: limit=10

limit

start
required
integer
Example: start=6

page

order
string

Permited values: name, customerId, phoneNumber, cartValue, abandonment, numProducts Example: name.desc Default is abandonment.desc

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "count": 1,
  • "payload": [
    ]
}

Get Ecom Abandoned Cart

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

limit
required
integer
Example: limit=10

limit

start
required
integer
Example: start=6

page

order
string

Permited values: name, customerId, phoneNumber, cartValue, abandonment, numProducts Example: name.desc Default is abandonment.desc

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "count": 1,
  • "payload": [
    ]
}

Graphs

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 Units

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).

Visits graph data

Get visits information as graph data

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

type
string
Value: "time-series"
Example: type=time-series
unit
string
Enum: "day" "week" "month" "year"
Example: unit=day

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

New visitors graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
type
required
string
Enum: "time-series" "pie" "bar"
Example: type=time-series
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Returning visitors graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
type
required
string
Enum: "time-series" "pie" "bar"
Example: type=time-series
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Converting visitors graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
type
required
string
Enum: "time-series" "pie" "bar"
Example: type=time-series
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Sessions graph data

Get sessions information as graph data

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
type
required
string
Enum: "time-series" "pie" "bar"
Example: type=time-series
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Sessions graph data

Get sessions information as graph data

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
type
required
string
Enum: "time-series" "pie" "bar"
Example: type=time-series
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Heatmaps

Heatmaps operations

Heatmap sessions data

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).

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

heatmapId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a heatmap

query Parameters
group
string
Example: group=country

Groups the results by filter. Only group by country option available

order
string
Enum: "desc" "asc"
Example: order=count.asc|desc or country.desc|asc

Orders the results from query ascending or descending.

pageSize
integer
Example: pageSize=20

Number of items per page to be requested

page
integer
Example: page=1

Page to be requested

Responses

Response samples

Content type
application/json
{
  • "payload": [
    ],
  • "meta": {
    }
}

Recordings

Recordings operations

Get average duration

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Get session recordings data

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
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

Responses

Request samples

Content type
application/json
{
  • "starred": "string",
  • "watched": "string",
  • "from": 0,
  • "until": 0,
  • "country": {
    },
  • "os": {
    },
  • "browser": {
    },
  • "devices": [
    ],
  • "status": [
    ],
  • "containsPage": "string",
  • "notContainsPage": "string",
  • "durations": {
    },
  • "pageCount": {
    },
  • "entryPage": "string",
  • "exitPage": "string",
  • "funnelDropouts": {
    },
  • "referrerURLs": [
    ],
  • "trafficChannels": [
    ],
  • "adCampaignLabels": [
    ]
}

Response samples

Content type
application/json
{
  • "sessionsTotal": 0,
  • "data": [
    ]
}

Get session recordings data

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
starred
string
watched
string
from
number <int64>
until
number <int64>
object
object
object
devices
Array of strings
status
Array of integers
containsPage
string
notContainsPage
string
object
object
entryPage
string
exitPage
string
object
referrerURLs
Array of strings
trafficChannels
Array of strings
adCampaignLabels
Array of strings
object

Responses

Request samples

Content type
application/json
{
  • "starred": "string",
  • "watched": "string",
  • "from": 0,
  • "until": 0,
  • "country": {
    },
  • "os": {
    },
  • "browser": {
    },
  • "devices": [
    ],
  • "status": [
    ],
  • "containsPage": "string",
  • "notContainsPage": "string",
  • "durations": {
    },
  • "pageCount": {
    },
  • "entryPage": "string",
  • "exitPage": "string",
  • "funnelDropouts": {
    },
  • "referrerURLs": [
    ],
  • "trafficChannels": [
    ],
  • "adCampaignLabels": [
    ],
  • "tags": {
    }
}

Response samples

Content type
application/json
{
  • "sessionsTotal": 0,
  • "data": [
    ]
}

Delete recordings by sessionIds

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
sessionIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "sessionIds": [
    ]
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete recordings

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
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

Responses

Request samples

Content type
application/json
{
  • "starred": "string",
  • "watched": "string",
  • "from": 0,
  • "until": 0,
  • "country": {
    },
  • "os": {
    },
  • "browser": {
    },
  • "devices": [
    ],
  • "status": [
    ],
  • "containsPage": "string",
  • "notContainsPage": "string",
  • "durations": {
    },
  • "pageCount": {
    },
  • "entryPage": "string",
  • "exitPage": "string",
  • "funnelDropouts": {
    },
  • "referrerURLs": [
    ],
  • "trafficChannels": [
    ],
  • "adCampaignLabels": [
    ]
}

Response samples

Content type
application/json
{
  • "sessionsTotal": 0,
  • "data": [
    ]
}

Funnels

Funnels operations

Funnels

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).

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter (default = until - 7 days)

until
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter (default = today's date)

previousFrom
string <date-time> (ISO8601)
Example: previousFrom=2018-01-01T00:00:00.000Z

Lower bound date filter; optional

previousUntil
string <date-time> (ISO8601)
Example: previousUntil=2022-04-18T22:59:59.000Z

Upper bound date filter; optional

status
number
Enum: 0 1 2

0 = pending or draft status, 1 = active status, 2 = limit reached status

search
string
Example: search=string

Regex for funnel name

order
string
Enum: "desc" "asc"
Example: order=count.asc|desc (only count ordering option)

TO BE IMPLEMENTED

Responses

Response samples

Content type
application/json
{
  • "payload": [
    ]
}

Funnel

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).

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

funnelId
required
string

Funnel ID

query Parameters
from
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter (default = until - 7 days)

until
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter (default = today's date)

previousFrom
string <date-time> (ISO8601)
Example: previousFrom=2018-01-01T00:00:00.000Z

Lower bound date filter; optional

previousUntil
string <date-time> (ISO8601)
Example: previousUntil=2022-04-18T22:59:59.000Z

Upper bound date filter; optional

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Multiple funnels

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).

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

Request Body schema: application/json
funnelIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "funnelIds": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "INVALID_CONTENT_TYPE"
}

Funnels average conversion rate

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).

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

Responses

Response samples

Content type
application/json
{
  • "payload": [
    ]
}

Funnels highest conversion rate

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).

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

Responses

Response samples

Content type
application/json
{
  • "payload": [
    ]
}

Custom Events

Operations about website custom events

Get Custom Events Overview

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).

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter.

page
integer
Example: page=1

Page to be requested

pageSize
integer
Example: pageSize=20

Number of items per page to be requested

action, category, label, pageTitle, element
string

action, category, label, pageTitle, element are allowed in text filtering results by one or more terms

group
string

one or more columns to group by ( format is option1,option2). Allowed options are 'action', 'category', 'value', 'label', 'pageTitle', 'element', 'type'

order
string

one ore more columns to order by 'asc' or 'desc' (format is option1.asc,option2.desc). If no direction is provided for a column 'desc' is assumed. Allowed options are 'action', 'category', 'value', 'label', 'pageTitle', 'element', 'type', 'createdAt'

Responses

Response samples

Content type
application/json
{
  • "payload": [
    ],
  • "meta": {
    }
}

Get Custom Events In Depth

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).

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter.

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
action, category, label, pageTitle, element
string

action, category, label, pageTitle, element are allowed in text filtering results by one or more terms

group
string

one or more columns to group by ( format is option1,option2). Allowed options are 'action', 'category', 'value', 'label', 'pageTitle', 'element', 'type'

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Get Custom Events Filters

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).

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
page
integer
Example: page=1

Page to be requested

pageSize
integer
Example: pageSize=20

Number of items per page to be requested

name
string

Filters the result based by custom event name. Multiple values are allowed (ex 'name=action,example')

Responses

Response samples

Content type
application/json
{
  • "payload": [
    ],
  • "meta": {
    }
}

Create Custom Event Filter

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).

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

Request Body schema: application/json
name
string

Represents the filter name

object

Responses

Request samples

Content type
application/json
{
  • "name": "Order by action",
  • "value": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Edit Custom Event Filter's Name

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).

path Parameters
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

Request Body schema: application/json
name
string

Represents the filter name

Responses

Request samples

Content type
application/json
{
  • "name": "Order by action edit"
}

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Delete Custom Event Filter

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).

path Parameters
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

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Surveys

Operations about website surveys

Create Survey

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).

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

Request Body schema: application/json
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

Responses

Request samples

Content type
application/json
{
  • "title": "My first survey",
  • "language": "en",
  • "status": 2,
  • "logoId": "string",
  • "advertising": true,
  • "questions": [
    ],
  • "appearance": {
    },
  • "settings": {}
}

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Get all Surveys with general stats

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).

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

Responses

Response samples

Content type
application/json
{
  • "payload": [
    ]
}

Get Survey

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

path Parameters
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}

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Edit Survey

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.

path Parameters
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}

Request Body schema: application/json
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

Responses

Request samples

Content type
application/json
{
  • "title": "My first survey",
  • "language": "en",
  • "status": 2,
  • "logoId": "string",
  • "advertising": true,
  • "questions": [
    ],
  • "appearance": {
    },
  • "settings": {}
}

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Delete Survey

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).

path Parameters
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}

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Activate/Deactivate Survey

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).

path Parameters
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}

Request Body schema: application/json
status
integer

Available options are 1 (Inactive), 3 (Active)

Request samples

Content type
application/json
{
  • "status": 3
}

Get Surveys count for 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).

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Get Survey Text Question Answers

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

path Parameters
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}

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Create Survey Question Answer For Public

Authentication is not needed.

path Parameters
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}

Request Body schema: application/json
body
string

Represents the answer for Short Answer, Long Answer, Email, Website, Phone, Date

value
integer

Represents the answer for Slider, Rating, Rating Scale

choices
Array of arrays
visitorKey
string
shownAt
timestamp

Responses

Request samples

Content type
application/json
{
  • "body": "My first answer",
  • "value": 2,
  • "choices": [
    ],
  • "visitorKey": "string",
  • "shownAt": 1608209339
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get Survey for Public

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

path Parameters
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}

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Create Survey Answer For Public

Authentication is not needed.

path Parameters
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}

Request Body schema: application/json
body
string

Represents the answer for Short Answer, Long Answer, Email, Website, Phone, Date

value
integer

Represents the answer for Slider, Rating, Rating Scale

choices
Array of arrays
visitorKey
string
questionId
string
shownAt
timestamp

Responses

Request samples

Content type
application/json
{
  • "body": "My first answer",
  • "value": 2,
  • "choices": [
    ],
  • "visitorKey": "string",
  • "questionId": "question-id",
  • "shownAt": 1608209339
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get All Surveys Average Completion Rate

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).

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Get All Surveys Responses Count

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).

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Get All Surveys Initiates

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).

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Get Survey Results

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).

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Get Survey General Stats

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).

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Polls

Operations about website polls

Create Poll

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).

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

Request Body schema: application/json
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

Responses

Request samples

Content type
application/json
{
  • "title": "My first poll",
  • "language": "en",
  • "status": 2,
  • "logoId": "string",
  • "advertising": true,
  • "dismissible": true,
  • "questions": [
    ],
  • "appearance": {
    },
  • "targeting": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Get all Polls with general stats

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).

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

Responses

Response samples

Content type
application/json
{
  • "payload": [
    ]
}

Get Poll

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

path Parameters
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}

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Edit Poll

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.

path Parameters
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}

Request Body schema: application/json
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

Responses

Request samples

Content type
application/json
{
  • "title": "My first poll",
  • "language": "en",
  • "status": 2,
  • "logoId": "string",
  • "advertising": true,
  • "dismissible": true,
  • "questions": [
    ],
  • "appearance": {
    },
  • "targeting": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Delete Poll

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).

path Parameters
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}

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Activate/Deactivate Poll

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).

path Parameters
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}

Request Body schema: application/json
status
integer

Available options are 1 (Inactive), 3 (Active)

Request samples

Content type
application/json
{
  • "status": 3
}

Get Polls count for 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).

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Get Poll Text Question Answers

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

path Parameters
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}

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Create Poll Question Answer For Public

Authentication is not needed.

path Parameters
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}

Request Body schema: application/json
body
string

Represents the answer for Short Answer, Long Answer, Email, Website, Phone, Date

value
integer

Represents the answer for Slider, Rating, Rating Scale

choices
Array of arrays
visitorKey
string
shownAt
timestamp

Responses

Request samples

Content type
application/json
{
  • "body": "My first answer",
  • "value": 2,
  • "choices": [
    ],
  • "visitorKey": "string",
  • "shownAt": 1608209339
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Poll dismiss for Public

path Parameters
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}

Request Body schema: application/json
visitorKey
string

Represents the visitor key for which poll should be dismissed

Responses

Request samples

Content type
application/json
{
  • "visitorKey": "visitor-id"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get All Polls Average Completion Rate

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).

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Get All Polls Responses Count

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).

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Get All Polls Initiates

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).

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Get Poll Results

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).

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Get Poll General Stats

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).

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Get Poll Participants

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).

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Get Poll Visitor Responses

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).

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Files

Operations about website files

Add image file for 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).

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

Request Body schema: multipart/form-data
file
string <binary>

Represents the content of file

extensions
string

This is optional. Accepted extensions are jpg, png, jpeg

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Themes

Operations about website themes

Theme

No authentication is needed.

query Parameters
supportCenterDomain
string
Example: supportCenterDomain=test.com

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Stats

Operations about website stats

Page Visits Stats

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

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "labels": [
    ],
  • "datasets": [
    ]
}

Overall Visitors Stats

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "labels": [
    ],
  • "datasets": [
    ]
}

Returning Visitors Stats

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "labels": [
    ],
  • "datasets": [
    ]
}

Unique Visitors Stats

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "labels": [
    ],
  • "datasets": [
    ]
}

Bounce Rate Stats

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "labels": [
    ],
  • "datasets": [
    ]
}

Page Referrers Stats

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

page
integer
Example: page=1

Page to be requested

pageSize
integer
Example: pageSize=20

Number of items per page to be requested

referrerUrl
string
Example: referrerUrl=https://google.com

the url of the referrer page

pageViewUrl
string
Example: pageViewUrl=https://google.com

the url of the page

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "payload": {}
}

Average Session Duration Stats

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "labels": [
    ],
  • "datasets": [
    ]
}

User Sessions Stats

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "labels": [
    ],
  • "datasets": [
    ]
}

Average Session Pages Stats

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "labels": [
    ],
  • "datasets": [
    ]
}

Graph

Get Ecom Sessions Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "totalCurrent": 200,
  • "totalPrevious": 199,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Sessions Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "totalCurrent": 200,
  • "totalPrevious": 199,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Customers Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "totalCurrent": 200,
  • "totalPrevious": 199,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Customers Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "totalCurrent": 200,
  • "totalPrevious": 199,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Orders Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "totalCurrent": 200,
  • "totalPrevious": 199,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Orders Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "totalCurrent": 200,
  • "totalPrevious": 199,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Sold Products Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "totalCurrent": 200,
  • "totalPrevious": 199,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Sold Products Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "totalCurrent": 200,
  • "totalPrevious": 199,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Gross Revenue Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "totalCurrent": 199.99,
  • "totalPrevious": 199.99,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Gross Revenue Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "totalCurrent": 199.99,
  • "totalPrevious": 199.99,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Net Revenue Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "totalCurrent": 199.99,
  • "totalPrevious": 199.99,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Net Revenue Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "totalCurrent": 199.99,
  • "totalPrevious": 199.99,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Session Purchase Ratio Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "totalCurrent": 199.99,
  • "totalPrevious": 199.99,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Session Purchase Ratio Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "totalCurrent": 199.99,
  • "totalPrevious": 199.99,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Checkout Purchase Ratio Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "totalCurrent": 199.99,
  • "totalPrevious": 199.99,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Checkout Purchase Ratio Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "totalCurrent": 199.99,
  • "totalPrevious": 199.99,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Revenue By Product

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
items
integer
Example: items=10

items

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get Ecom Revenue By Product

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
items
integer
Example: items=10

items

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Ecom Units Sold By Product

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
items
integer
Example: items=10

items

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get Ecom Units Sold By Product

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
items
integer
Example: items=10

items

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Ecom Checkout Initiated Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "totalCurrent": 20,
  • "totalPrevious": 20,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Checkout Initiated Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "totalCurrent": 20,
  • "totalPrevious": 20,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Cart Viewed Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "totalCurrent": 20,
  • "totalPrevious": 20,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Cart Viewed Graph

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "totalCurrent": 20,
  • "totalPrevious": 20,
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Traffic Structure Overview

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Traffic Structure Overview

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Traffic Structure In Depth

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

unit
required
string
Enum: "day" "week" "month" "year"
Example: unit=day
timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Request Body schema: application/json
object
Array of objects
object
object
Array of objects
primaryDimension
string

optional

Responses

Request samples

Content type
application/json
{
  • "where": {
    },
  • "order": [
    ],
  • "timeframe": {
    },
  • "pagination": {
    },
  • "segments": [
    ],
  • "primaryDimension": "string"
}

Response samples

Content type
application/json
{
  • "current": [
    ],
  • "previous": [
    ]
}

Get Ecom Traffic Structure In Depth

path Parameters
websiteId
required
string <uuid> (uuid)
Example: 06d99a32-ee11-11eb-830a-0146de130018

ID of a website

query Parameters
from
required
string <date-time> (ISO8601)
Example: from=2018-01-01T00:00:00.000Z

Lower bound date filter

until
required
string <date-time> (ISO8601)
Example: until=2022-04-18T22:59:59.000Z

Upper bound date filter

timezone
string

Timezone of the user.

header Parameters
X-Timezone
string

Timezone of the user.

Responses

Response samples

Content type
application/json
{
  • "current": [
    ],
  • "previous": [
    ]
}