Skip to main content
GET
/
events
Aggregate Event Counts
curl --request GET \
  --url https://{regionAndDomain}.com/api/query/events \
  --header 'Authorization: Basic <encoded-value>'
{
  "data": {
    "series": [
      "2010-05-29",
      "2010-05-30",
      "2010-05-31"
    ],
    "values": {
      "account-page": {
        "2010-05-30": 1
      },
      "splash features": {
        "2010-05-29": 6,
        "2010-05-30": 4,
        "2010-05-31": 5
      }
    }
  },
  "legend_size": 2
}

Authorizations

​
Authorization
string
header
required

Service Account

Query Parameters

​
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 or events that you wish to get data for, encoded as a JSON array. Example format: "["play song", "log in", "add playlist"]".

​
type
enum<string>
required

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

Available options:
general,
unique,
average
​
unit
enum<string>
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.

Available options:
minute,
hour,
day,
week,
month
​
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
enum<string>

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

Available options:
json,
csv

Response

200 - application/json

Success.

​
data
object
​
legend_size
integer

The number of events defined in values