AesirX Analytics 1st Party API Guide

1st Party API

AesirX Analytics 1st party API

health

get

/healthGets health status of the system

Gets health status of the system Simple GET command to get a health status of the system

Parameters

No parameters

Responses

Example

{
  "status": "ok",
  "version": "1.0.0"
}

visitor

post

/visitor/v1/initInitializes a new visitor (first visit)

Initializes a new visitor (first visit) Registers a new visitor in the Analytics system and a first visit

Parameters

No parameters

Request Body ^REQUIRED

application/json

Example

{
  "attributes": [
    true
  ],
  "browser_name": "string",
  "browser_version": "string",
  "device": "string",
  "event_name": "string",
  "event_type": "string",
  "ip": "string",
  "lang": "string",
  "referer": "string",
  "url": "string",
  "user_agent": "string"
}

Responses

Example

{
  "event_uuid": "string",
  "flow_uuid": "string",
  "visitor_uuid": "string"
}

post

/visitor/v1/startStarts a new event for a registered visitor

Starts a new event for a registered visitor Registers a new visit/event for a certain visitor

Parameters

No parameters

Request Body ^REQUIRED

application/json

Example

{
  "attributes": [
    true
  ],
  "event_name": "string",
  "event_type": "string",
  "event_uuid": "string",
  "referer": "string",
  "url": "string",
  "visitor_uuid": "string"
}

Responses

Example

{
  "event_uuid": "string",
  "flow_uuid": "string",
  "visitor_uuid": "string"
}

post

/visitor/v1/endFinalizes and event or visit

Finalizes and event or visit Marks the end of a certain event

Parameters

No parameters

Request Body ^REQUIRED

application/json

Example

{
  "event_uuid": "string",
  "visitor_uuid": "string"
}

Responses

Example

{
  "visitor_uuid": "string"
}

post

/visitor/v2/startInitializes and start a new visitor

Initializes and start a new visitor Registers a new visitor in the Analytics system and a first visit

Parameters

No parameters

Request Body ^REQUIRED

application/json

Example

{
  "attributes": [
    true
  ],
  "browser_name": "string",
  "browser_version": "string",
  "device": "string",
  "event_name": "string",
  "event_type": "string",
  "fingerprint": "string",
  "ip": "string",
  "lang": "string",
  "referer": "string",
  "url": "string",
  "user_agent": "string"
}

Responses

Example

{
  "event_uuid": "string",
  "flow_uuid": "string",
  "visitor_uuid": "string"
}

post

/consent/v1/allReturns list of consents

Returns list of consents Returns list of consents related to jwt and/or wallet and/or visitor uuid

Parameters

No parameters

Request Body

application/json

Example

undefined

Responses

Example

{
  "consents": [
    true
  ],
  "consents_by_domain": [
    true
  ]
}

get

/visitor/v1/{uuid}Returns visitor by its uuid

Returns visitor by its uuid Returns the whole object of the visitor given its uuid and containing the visitor_consents records that are still active (where the expiration has not passed).

Parameters

Name	Required	Type	Description
uuid* (path)	Yes	string ($uuid)
expired (query)	No	boolean

Responses

Example

{
  "browser_name": "string",
  "browser_version": "string",
  "device": "string",
  "domain": "string",
  "ip": "string",
  "lang": "string",
  "user_agent": "string",
  "uuid": "string",
  "visitor_consents": [
    true
  ],
  "visitor_flows": [
    true
  ]
}

post

/consent/v1/level1/{uuid}/{consent}Posts a new visitor_consent to the given id and using the consent number.

Posts a new visitor_consent to the given id and using the consent number.

Parameters

Name	Required	Type	Description
uuid* (path)	Yes	string ($uuid)
consent* (path)	Yes	integer ($int32)

Responses

Example

true

post

/consent/v1/level2/{uuid}Posts a new visitor_consent to the given id and using the consent number with a web3id.

Posts a new visitor_consent to the given id and using the consent number with a web3id.

Parameters

Name	Required	Type	Description
uuid* (path)	Yes	string ($uuid)

Request Body ^REQUIRED

application/json

Example

{
  "consent": [
    0
  ]
}

Responses

Example

true

post

/consent/v1/level3/{uuid}/{network}/{wallet}Posts a new visitor_consent to the given id and using the consent number with a wallet.

Posts a new visitor_consent to the given id and using the consent number with a wallet.

Parameters

Name	Required	Type	Description
uuid* (path)	Yes	string ($uuid)	uuid of visitor
network* (path)	Yes	string	Network (concordium)
wallet* (path)	Yes	string	Wallet Address

Request Body ^REQUIRED

application/json

Example

{
  "consent": [
    0
  ],
  "signature": "string"
}

Responses

Example

true

post

/consent/v1/level4/{uuid}/{network}/{web3id}/{wallet}Posts a new visitor_consent to the given id and using the consent number with with a web3id validated via wallet.

Posts a new visitor_consent to the given id and using the consent number with with a web3id validated via wallet.

Parameters

Name	Required	Type
uuid* (path)	Yes	string ($uuid)
network* (path)	Yes	string
web3id* (path)	Yes	string
wallet* (path)	Yes	string

Request Body ^REQUIRED

application/json

Example

{
  "consent": [
    0
  ],
  "signature": "string"
}

Responses

Example

true

put

/consent/v1/level2/revoke/{consent_uuid}Revoke Consent Level 2.

Revoke Consent Level 2.

Parameters

Name	Required	Type	Description
consent_uuid* (path)	Yes	string ($uuid)

Responses

Example

true

put

/consent/v1/level3/revoke/{consent_uuid}/{network}/{wallet}Revoke Consent Level 3.

Revoke Consent Level 3.

Parameters

Name	Required	Type
consent_uuid* (path)	Yes	string ($uuid)
network* (path)	Yes	string
wallet* (path)	Yes	string

Request Body ^REQUIRED

application/json

Example

{
  "signature": "string"
}

Responses

Example

true

put

/consent/v1/level4/revoke/{consent_uuid}/{network}/{web3id}/{wallet}Revoke Consent Level 4.

Revoke Consent Level 4.

Parameters

Name	Required	Type
consent_uuid* (path)	Yes	string ($uuid)
network* (path)	Yes	string
web3id* (path)	Yes	string
wallet* (path)	Yes	string

Request Body ^REQUIRED

application/json

Example

{
  "signature": "string"
}

Responses

Example

true

get

/consent/v1/level2/listList Consent Level 2.

List Consent Level 2.

Parameters

Name	Required	Type	Description
expired (query)	No	boolean

Responses

Example

{
  "consents": [
    true
  ],
  "consents_by_domain": [
    true
  ]
}

get

/consent/v1/level3/list/{network}/{wallet}List Consent Level 3.

List Consent Level 3.

Parameters

Name	Required	Type
network* (path)	Yes	string
wallet* (path)	Yes	string
expired (query)	No	boolean
signature* (query)	Yes	string

Responses

Example

{
  "consents": [
    true
  ],
  "consents_by_domain": [
    true
  ]
}

get

/consent/v1/level4/list/{network}/{web3id}/{wallet}List Consent Level 4.

List Consent Level 4.

Parameters

Name	Required	Type
network* (path)	Yes	string
web3id* (path)	Yes	string
wallet* (path)	Yes	string
expired (query)	No	boolean
signature* (query)	Yes	string

Responses

Example

{
  "consents": [
    true
  ],
  "consents_by_domain": [
    true
  ]
}

wallet

post

/wallet/v1/{network}/{address}/nonceGets a new nonce (random) for the address sent.

Gets a new nonce (random) for the address sent.

Parameters

Name	Required	Type	Description
network* (path)	Yes	string
address* (path)	Yes	string

Request Body ^REQUIRED

application/json

Example

{
  "text": "string"
}

Responses

Example

{
  "nonce": "string"
}

statistics

get

/metrics/v1/{start_date}/{end_date}1st party metrics

1st party metrics Loads the stored 1st party summarized metrics

Parameters

Name	Required	Type	Description
filter (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
filter_not (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
with[] (query)	No	array	Load additional related data
page (query)	No	integer ($int32)	Number of page (default = 1)
page_size (query)	No	integer ($int32)	Number of records per page (default = 20)
sort[] (query)	No	array	Sort based on the given fields. Multiple values are allowed.
sort_direction[] (query)	No	array	Direction of sort (default = asc, allowed: asc, desc). Multiple values are allowed.
start_date* (path)	Yes	string	Start date filter
end_date* (path)	Yes	string	End date filter

Responses

Example

{
  "average_number_of_pages_per_session": "integer",
  "average_session_duration": "integer",
  "bounce_rate": "integer",
  "number_of_page_views": "integer",
  "number_of_unique_page_views": "integer",
  "number_of_visitors": "integer"
}

get

/visits/v1/{start_date}/{end_date}Daily detail of page visits

Daily detail of page visits Loads a collection of daily visits given a paginated time range

Parameters

Name	Required	Type	Description
filter (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
filter_not (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
with[] (query)	No	array	Load additional related data
page (query)	No	integer ($int32)	Number of page (default = 1)
page_size (query)	No	integer ($int32)	Number of records per page (default = 20)
sort[] (query)	No	array	Sort based on the given fields (default = date, allowed: date, visits, unique_visits). Multiple values are allowed.
sort_direction[] (query)	No	array	Direction of sort (default = asc, allowed: asc, desc). Multiple values are allowed.
start_date* (path)	Yes	string	Start date filter
end_date* (path)	Yes	string	End date filter

Responses

Example

{
  "collection": [
    true
  ],
  "page": "integer",
  "page_size": "integer",
  "total_elements": "integer",
  "total_pages": "integer"
}

get

/domains/v1/{start_date}/{end_date}Daily detail of domain visits

Daily detail of domain visits Loads a collection of daily domain visits given a paginated time range

Parameters

Name	Required	Type	Description
filter (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
filter_not (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
with[] (query)	No	array	Load additional related data
page (query)	No	integer ($int32)	Number of page (default = 1)
page_size (query)	No	integer ($int32)	Number of records per page (default = 20)
sort[] (query)	No	array	Sort based on the given fields (default = domain, allowed: domain, number_of_visitors, number_of_page_views, number_of_unique_page_views, average_session_duration, average_number_of_pages_per_session, bounce_rate). Multiple values are allowed.
sort_direction[] (query)	No	array	Direction of sort (default = asc, allowed: asc, desc). Multiple values are allowed.
start_date* (path)	Yes	string	Start date filter
end_date* (path)	Yes	string	End date filter

Responses

Example

{
  "collection": [
    true
  ],
  "page": "integer",
  "page_size": "integer",
  "total_elements": "integer",
  "total_pages": "integer"
}

get

/visitors/v1/{start_date}/{end_date}Daily detail of visitor visits

Daily detail of visitor visits Loads a collection of daily visitor visits given a paginated time range

Parameters

Name	Required	Type	Description
filter (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
filter_not (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
with[] (query)	No	array	Load additional related data
page (query)	No	integer ($int32)	Number of page (default = 1)
page_size (query)	No	integer ($int32)	Number of records per page (default = 20)
sort[] (query)	No	array	Sort based on the given fields (default = date, allowed: date, visits). Multiple values are allowed.
sort_direction[] (query)	No	array	Direction of sort (default = asc, allowed: asc, desc). Multiple values are allowed.
start_date* (path)	Yes	string	Start date filter
end_date* (path)	Yes	string	End date filter

Responses

Example

{
  "collection": [
    true
  ],
  "page": "integer",
  "page_size": "integer",
  "total_elements": "integer",
  "total_pages": "integer"
}

get

/pages/v1/{start_date}/{end_date}Daily detail of page visits

Daily detail of page visits Loads a collection of daily page visits given a paginated time range

Parameters

Name	Required	Type	Description
filter (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
filter_not (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
with[] (query)	No	array	Load additional related data
page (query)	No	integer ($int32)	Number of page (default = 1)
page_size (query)	No	integer ($int32)	Number of records per page (default = 20)
sort[] (query)	No	array	Sort based on the given fields (default = url, allowed: url, number_of_visitors, number_of_page_views, number_of_unique_page_views, average_session_duration, average_number_of_pages_per_session, bounce_rate). Multiple values are allowed.
sort_direction[] (query)	No	array	Direction of sort (default = asc, allowed: asc, desc). Multiple values are allowed.
start_date* (path)	Yes	string	Start date filter
end_date* (path)	Yes	string	End date filter

Responses

Example

{
  "collection": [
    true
  ],
  "page": "integer",
  "page_size": "integer",
  "total_elements": "integer",
  "total_pages": "integer"
}

get

/browsers/v1/{start_date}/{end_date}Daily detail of browser visits

Daily detail of browser visits Loads a collection of daily browser visits given a paginated time range

Parameters

Name	Required	Type	Description
filter (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
filter_not (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
with[] (query)	No	array	Load additional related data
page (query)	No	integer ($int32)	Number of page (default = 1)
page_size (query)	No	integer ($int32)	Number of records per page (default = 20)
sort[] (query)	No	array	Sort based on the given fields (default = browser_name, allowed: browser_name, number_of_visitors, number_of_page_views, number_of_unique_page_views, average_session_duration, average_number_of_pages_per_session, bounce_rate). Multiple values are allowed.
sort_direction[] (query)	No	array	Direction of sort (default = asc, allowed: asc, desc). Multiple values are allowed.
start_date* (path)	Yes	string	Start date filter
end_date* (path)	Yes	string	End date filter

Responses

Example

{
  "collection": [
    true
  ],
  "page": "integer",
  "page_size": "integer",
  "total_elements": "integer",
  "total_pages": "integer"
}

get

/browserversions/v1/{start_date}/{end_date}Daily detail of browser version visits

Daily detail of browser version visits Loads a collection of daily browser version visits given a paginated time range

Parameters

Name	Required	Type	Description
filter (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
filter_not (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
with[] (query)	No	array	Load additional related data
page (query)	No	integer ($int32)	Number of page (default = 1)
page_size (query)	No	integer ($int32)	Number of records per page (default = 20)
sort[] (query)	No	array	Sort based on the given fields (default = browser_version, allowed: browser_version, number_of_visitors, number_of_page_views, number_of_unique_page_views, average_session_duration, average_number_of_pages_per_session, bounce_rate). Multiple values are allowed.
sort_direction[] (query)	No	array	Direction of sort (default = asc, allowed: asc, desc). Multiple values are allowed.
start_date* (path)	Yes	string	Start date filter
end_date* (path)	Yes	string	End date filter

Responses

Example

{
  "collection": [
    true
  ],
  "page": "integer",
  "page_size": "integer",
  "total_elements": "integer",
  "total_pages": "integer"
}

get

/languages/v1/{start_date}/{end_date}Daily detail of language visits

Daily detail of language visits Loads a collection of daily language visits given a paginated time range

Parameters

Name	Required	Type	Description
filter (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
filter_not (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
with[] (query)	No	array	Load additional related data
page (query)	No	integer ($int32)	Number of page (default = 1)
page_size (query)	No	integer ($int32)	Number of records per page (default = 20)
sort[] (query)	No	array	Sort based on the given fields (default = lang, allowed: lang, number_of_visitors, number_of_page_views, number_of_unique_page_views, average_session_duration, average_number_of_pages_per_session, bounce_rate). Multiple values are allowed.
sort_direction[] (query)	No	array	Direction of sort (default = asc, allowed: asc, desc). Multiple values are allowed.
start_date* (path)	Yes	string	Start date filter
end_date* (path)	Yes	string	End date filter

Responses

Example

{
  "collection": [
    true
  ],
  "page": "integer",
  "page_size": "integer",
  "total_elements": "integer",
  "total_pages": "integer"
}

get

/devices/v1/{start_date}/{end_date}Daily detail of device visits

Daily detail of device visits Loads a collection of daily device visits given a paginated time range

Parameters

Name	Required	Type	Description
filter (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
filter_not (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
with[] (query)	No	array	Load additional related data
page (query)	No	integer ($int32)	Number of page (default = 1)
page_size (query)	No	integer ($int32)	Number of records per page (default = 20)
sort[] (query)	No	array	Sort based on the given fields (default = device, allowed: device, number_of_visitors, number_of_page_views, number_of_unique_page_views, average_session_duration, average_number_of_pages_per_session, bounce_rate). Multiple values are allowed.
sort_direction[] (query)	No	array	Direction of sort (default = asc, allowed: asc, desc). Multiple values are allowed.
start_date* (path)	Yes	string	Start date filter
end_date* (path)	Yes	string	End date filter

Responses

Example

{
  "collection": [
    true
  ],
  "page": "integer",
  "page_size": "integer",
  "total_elements": "integer",
  "total_pages": "integer"
}

get

/countries/v1/{start_date}/{end_date}Daily detail of country visits

Daily detail of country visits Loads a collection of daily country visits given a paginated time range

Parameters

Name	Required	Type	Description
filter (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
filter_not (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
with[] (query)	No	array	Load additional related data
page (query)	No	integer ($int32)	Number of page (default = 1)
page_size (query)	No	integer ($int32)	Number of records per page (default = 20)
sort[] (query)	No	array	Sort based on the given fields (default = country_code, allowed: country_name, country_code, number_of_visitors, number_of_page_views, number_of_unique_page_views, average_session_duration, average_number_of_pages_per_session, bounce_rate). Multiple values are allowed.
sort_direction[] (query)	No	array	Direction of sort (default = asc, allowed: asc, desc). Multiple values are allowed.
start_date* (path)	Yes	string	Start date filter
end_date* (path)	Yes	string	End date filter

Responses

Example

{
  "collection": [
    true
  ],
  "page": "integer",
  "page_size": "integer",
  "total_elements": "integer",
  "total_pages": "integer"
}

get

/cities/v1/{start_date}/{end_date}Daily detail of city visits

Daily detail of city visits Loads a collection of daily city visits given a paginated time range

Parameters

Name	Required	Type	Description
filter (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
filter_not (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
with[] (query)	No	array	Load additional related data
page (query)	No	integer ($int32)	Number of page (default = 1)
page_size (query)	No	integer ($int32)	Number of records per page (default = 20)
sort[] (query)	No	array	Sort based on the given fields (default = city, allowed: city, number_of_visitors, number_of_page_views, number_of_unique_page_views, average_session_duration, average_number_of_pages_per_session, bounce_rate). Multiple values are allowed.
sort_direction[] (query)	No	array	Direction of sort (default = asc, allowed: asc, desc). Multiple values are allowed.
start_date* (path)	Yes	string	Start date filter
end_date* (path)	Yes	string	End date filter

Responses

Example

{
  "collection": [
    true
  ],
  "page": "integer",
  "page_size": "integer",
  "total_elements": "integer",
  "total_pages": "integer"
}

get

/isps/v1/{start_date}/{end_date}Daily detail of isp visits

Daily detail of isp visits Loads a collection of daily isp visits given a paginated time range

Parameters

Name	Required	Type	Description
filter (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
filter_not (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
with[] (query)	No	array	Load additional related data
page (query)	No	integer ($int32)	Number of page (default = 1)
page_size (query)	No	integer ($int32)	Number of records per page (default = 20)
sort[] (query)	No	array	Sort based on the given fields (default = isp, allowed: isp, number_of_visitors, number_of_page_views, number_of_unique_page_views, average_session_duration, average_number_of_pages_per_session, bounce_rate). Multiple values are allowed.
sort_direction[] (query)	No	array	Direction of sort (default = asc, allowed: asc, desc). Multiple values are allowed.
start_date* (path)	Yes	string	Start date filter
end_date* (path)	Yes	string	End date filter

Responses

Example

{
  "collection": [
    true
  ],
  "page": "integer",
  "page_size": "integer",
  "total_elements": "integer",
  "total_pages": "integer"
}

get

/attribute/v1/{start_date}/{end_date}Detail of attribute value from time range

Detail of attribute value from time range Loads a collection of attribute value given a paginated time range

Parameters

Name	Required	Type	Description
filter (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
filter_not (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
with[] (query)	No	array	Load additional related data
page (query)	No	integer ($int32)	Number of page (default = 1)
page_size (query)	No	integer ($int32)	Number of records per page (default = 20)
sort[] (query)	No	array	Sort based on the given fields. Multiple values are allowed.
sort_direction[] (query)	No	array	Direction of sort (default = asc, allowed: asc, desc). Multiple values are allowed.
start_date* (path)	Yes	string	Start date filter
end_date* (path)	Yes	string	End date filter

Responses

Example

{
  "collection": [
    true
  ],
  "page": "integer",
  "page_size": "integer",
  "total_elements": "integer",
  "total_pages": "integer"
}

get

/attribute_date/v1/{start_date}/{end_date}Daily detail of attribute value

Daily detail of attribute value Loads a collection of daily attribute value given a paginated time range

Parameters

Name	Required	Type	Description
filter (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
filter_not (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
with[] (query)	No	array	Load additional related data
page (query)	No	integer ($int32)	Number of page (default = 1)
page_size (query)	No	integer ($int32)	Number of records per page (default = 20)
sort[] (query)	No	array	Sort based on the given fields. Multiple values are allowed.
sort_direction[] (query)	No	array	Direction of sort (default = asc, allowed: asc, desc). Multiple values are allowed.
start_date* (path)	Yes	string	Start date filter
end_date* (path)	Yes	string	End date filter

Responses

Example

{
  "collection": [
    true
  ],
  "page": "integer",
  "page_size": "integer",
  "total_elements": "integer",
  "total_pages": "integer"
}

get

/events/v1/{start_date}/{end_date}Get list events

Get list events Loads a collection of events given a paginated time range

Parameters

Name	Required	Type	Description
filter (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
filter_not (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
with[] (query)	No	array	Load additional related data
page (query)	No	integer ($int32)	Number of page (default = 1)
page_size (query)	No	integer ($int32)	Number of records per page (default = 20)
sort[] (query)	No	array	Sort based on the given fields (default = date, allowed: date, visits, event_name, event_type). Multiple values are allowed.
sort_direction[] (query)	No	array	Direction of sort (default = asc, allowed: asc, desc). Multiple values are allowed.
start_date* (path)	Yes	string	Start date filter
end_date* (path)	Yes	string	End date filter

Responses

Example

{
  "collection": [
    true
  ],
  "page": "integer",
  "page_size": "integer",
  "total_elements": "integer",
  "total_pages": "integer"
}

get

/events_name_type/v1/{start_date}/{end_date}Get list of events with grouped total_visitor counter

Get list of events with grouped total_visitor counter Loads a collection of events with grouped total_visitor counter given a paginated time range

Parameters

Name	Required	Type	Description
filter (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
filter_not (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
with[] (query)	No	array	Load additional related data
page (query)	No	integer ($int32)	Number of page (default = 1)
page_size (query)	No	integer ($int32)	Number of records per page (default = 20)
sort[] (query)	No	array	Sort based on the given fields (default = event_name, allowed: visits, event_name, event_type). Multiple values are allowed.
sort_direction[] (query)	No	array	Direction of sort (default = asc, allowed: asc, desc). Multiple values are allowed.
start_date* (path)	Yes	string	Start date filter
end_date* (path)	Yes	string	End date filter

Responses

Example

{
  "collection": [
    true
  ],
  "page": "integer",
  "page_size": "integer",
  "total_elements": "integer",
  "total_pages": "integer"
}

list

get

/visitor/v1/{start_date}/{end_date}Daily detail of events

Daily detail of events Loads a collection of daily events given a paginated time range

Parameters

Name	Required	Type	Description
filter (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
filter_not (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
with[] (query)	No	array	Load additional related data
page (query)	No	integer ($int32)	Number of page (default = 1)
page_size (query)	No	integer ($int32)	Number of records per page (default = 20)
sort[] (query)	No	array	Sort based on the given fields (default = start, allowed: start, end). Multiple values are allowed.
sort_direction[] (query)	No	array	Direction of sort (default = asc, allowed: asc, desc). Multiple values are allowed.
start_date* (path)	Yes	string	Start date filter
end_date* (path)	Yes	string	End date filter

Responses

Example

{
  "collection": [
    true
  ],
  "page": "integer",
  "page_size": "integer",
  "total_elements": "integer",
  "total_pages": "integer"
}

get

/flow/v1/{flow_uuid}List of visitors with flows and events if requested

List of visitors with flows and events if requested Loads a collection of paginated visitors, additionally can be loaded related events and lows

Parameters

Name	Required	Type	Description
filter (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
filter_not (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
with[] (query)	No	array	Load additional related data
page (query)	No	integer ($int32)	Number of page (default = 1)
page_size (query)	No	integer ($int32)	Number of records per page (default = 20)
sort[] (query)	No	array	Sort based on the given fields. Multiple values are allowed.
sort_direction[] (query)	No	array	Direction of sort (default = asc, allowed: asc, desc). Multiple values are allowed.
flow_uuid* (path)	Yes	string ($uuid)

Responses

Example

{
  "browser_name": "string",
  "browser_version": "string",
  "device": "string",
  "domain": "string",
  "end": "string",
  "events": [
    true
  ],
  "ip": "string",
  "lang": "string",
  "start": "string",
  "user_agent": "string",
  "uuid": "string"
}

get

/flow/v1/{start_date}/{end_date}Daily detail of flows

Daily detail of flows Loads a collection of daily flows given a paginated time range

Parameters

Name	Required	Type	Description
filter (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
filter_not (query)	No	object	Multiple values are allowed.
Example { "domain": "example.com", "url": "https://example.com/about", "browser_name": "Chrome", "browser_version": "100", "device": "string", "lang": "en-GB", "country_code": "DK", "country_name": "Denmark", "city": "BRABAND", "isp": "TDC BB-ADSL USERS", "event_name": "visit", "event_type": "action", "uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "visitor_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "flow_uuid": "deaa4f04-eab4-4e14-b290-ea6411b39ada", "attribute_name": "utm_source", "attribute_value": "facebook", "attribute": { "visit": [ "action" ] } }
with[] (query)	No	array	Load additional related data
page (query)	No	integer ($int32)	Number of page (default = 1)
page_size (query)	No	integer ($int32)	Number of records per page (default = 20)
sort[] (query)	No	array	Sort based on the given fields. Multiple values are allowed.
sort_direction[] (query)	No	array	Direction of sort (default = asc, allowed: asc, desc). Multiple values are allowed.
start_date* (path)	Yes	string	Start date filter
end_date* (path)	Yes	string	End date filter

Responses

Example

{
  "collection": [
    true
  ],
  "page": "integer",
  "page_size": "integer",
  "total_elements": "integer",
  "total_pages": "integer"
}

Enjoyed this read? Share the blog!

TABLE OF CONTENTS

health

get/health

visitor

consent

wallet

post/wallet/v1/{network}/{address}/nonce

statistics

list

PRIVACY & SECURITY

AUTOMATION & SCALE

AesirX Analytics 1st Party API Guide