Query Segmentation Report

get

https://{regionAndDomain}.com/api/query/segmentation

Get data for an event, segmented and filtered by properties. The Query API has a rate limit of 60 queries per hour and a maximum of 5 concurrent queries.

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.

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.

string

The property expression to segment the event on. See the expression to segment below.

unit

string

enum

This can be "minute", "hour", "day", or "month". This determines the buckets into which the property values that you segment on are placed. The default value is "day".

Allowed:

interval

integer

Optional parameter in lieu of 'unit' when 'type' is not 'general'. Determines the number of days your results are bucketed into can be used with or without 'from_date' and 'to_date' parameters.

where

string

An expression to filter events by. See the expression to segment below.

limit

integer

Return the top property values. Defaults to 60. Maximum value 10,000. This parameter does nothing if "on" is not specified.

type

string

enum

This can be "general", "unique", or "average". If this is set to "unique", we return the unique count of events or property values. If set to "general", we return the total, including repeats. If set to "average", we return the average count. The default value is "general".

Allowed:

format

string

enum

Can be set to "csv".

Allowed:

Response

Language

Credentials

URL

Response

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

application/json

200Success.