Session data

Get numeric session property statistics

GET/api/websites/{websiteId}/session-data/numeric-stats

Returns the total, average, median, minimum, and maximum of the specified numeric session property for the selected date range and filters.

Headers

Name	Type	Description
Authorizationrequired	string	Authentication credentials, e.g. `Bearer <token>`.

Path parameters

Name	Type	Description
websiteIdrequired	string	ID of the website.

Query parameters

Name	Type	Description
startAtrequired	integer	Start of the date range as a Unix timestamp in milliseconds.
endAtrequired	integer	End of the date range as a Unix timestamp in milliseconds.
propertyNamerequired	string	Name of the custom event or session property.
timezone	string	IANA time zone used to interpret dates and group results, for example America/New_York.
path	string	Filter by page URL path.
referrer	string	Filter by referring URL.
title	string	Filter by page title.
query	string	Filter by page URL query string.
os	string	Operating system used by the visitor.
browser	string	Browser used by the visitor.
device	string	Device category used by the visitor.
country	string	Country code of the visitor.
region	string	Region or subdivision of the visitor.
city	string	City of the visitor.
tag	string	Tag attached to the tracked activity.
hostname	string	Hostname on which the activity occurred.
distinctId	string	Custom identifier assigned to the visitor.
language	string	Preferred language reported by the visitor browser.
event	string	Filter by custom event name.
utmSource	string	UTM campaign source.
utmMedium	string	UTM campaign medium.
utmCampaign	string	UTM campaign name.
utmContent	string	UTM campaign content.
utmTerm	string	UTM campaign search term.
excludeBounce	string	Set a non-empty value to exclude visits with only one pageview.
segment	string	ID of a saved segment used to filter results.
cohort	string	ID of a saved cohort used to filter visitors.
eventType	integer	Event type: 1 for a pageview or 2 for a custom event.
match	enum<string>	Whether records must match all filters or any filter. Options: `all`, `any`

Responses

200The operation completed successfully.

Name	Type	Description
averagerequired	number	Arithmetic mean of the numeric property values.
maxrequired	number	Maximum numeric property value.
medianrequired	number	Median of the numeric property values.
minrequired	number	Minimum numeric property value.
totalrequired	number

200 example

{
  "average": 0,
  "max": 0,
  "median": 0,
  "min": 0,
  "total": 0
}

400Bad request.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

400 example

{
  "error": {
    "code": "bad-request",
    "message": "Bad request.",
    "status": 400
  }
}

401Unauthorized.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

401 example

{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized.",
    "status": 401
  }
}

Code samples

cURL

curl -X GET 'https://api.example.com/api/websites/{websiteId}/session-data/numeric-stats?startAt=0&endAt=0&propertyName=string' \
  -H 'Authorization: Bearer <token>'

PreviousGet numeric session properties over time NextList session property usage