Aggregated Event Property Values

get

https://{regionAndDomain}.com/api/query/events/properties

Get unique, total, or average data for of a single event and property over days, weeks, or months. The Query API has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

project_id

integer

required

Required if using service account to authenticate request.

workspace_id

integer

The id of the workspace if applicable.

event

string

required

The event that you wish to get data for. Note: this is a single event name, not an array.

name

string

required

The name of the property you would like to get data for.

values

array of strings

The specific property values that you would like to get data for, encoded as a JSON array. Example: If you have a property "gender" you may have values "male", "female" and "unknown". If you just want data for female and unknown users, you can include a values property that looks like "["female", "unknown"]".

values

type

string

enum

required

The analysis type you would like to get data for - such as general, unique, or average events. Valid values: "general", "unique", or "average".

Allowed:

unit

string

enum

required

This can be "minute", "hour", "day", "week", or "month". It determines the level of granularity of the data you get back. Note that you cannot get hourly uniques.

Allowed:

interval

integer

The number of "units" to return data for - minutes, hours, days, weeks, or months. 1 will return data for the current unit (minute, hour, day, week or month). 2 will return the current and previous units, and so on. Specify either interval or from_date and to_date.

from_date

string

required

The date in yyyy-mm-dd format to begin querying from. This date is inclusive.

to_date

string

required

The date in yyyy-mm-dd format to query to. This date is inclusive.

format

string

enum

The data return format, such as JSON or CSV. Options: "json" (default), "csv".

Allowed:

limit

integer

The maximum number of values to return. Defaults to 255.

Response

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success.