Query Retention Report

Time	Status	User Agent
Retrieving recent requests…

project_id

integer

required

Required if using service account to authenticate request.

workspace_id

integer

The id of the workspace if applicable.

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.

retention_type

string

enum

Must be either "birth" or "compounded". Defaults to "birth". The “birth” retention type corresponds to first time retention. The “compounded” retention type corresponds to recurring retention. See the Types of Retention article for more information.

Allowed:

born_event

string

The first event a user must do to be counted in a birth retention cohort. Required when retention_type is "birth"; ignored otherwise.

event

string

The event to generate returning counts for. Applies to both birth and compounded retention. If not specified, we look across all events.

born_where

string

An expression to filter born_events by. See the expressions section above.

where

string

An expression to filter born_events by. See the expressions section above.

interval

integer

The number of units (can be specified in either days, weeks, or months) that you want per individual bucketed interval. May not be greater than 90 days if days is the specified unit. The default value is 1.

interval_count

integer

The number of individual buckets, or intervals, that are returned; defaults to 1. Note that we include a "0th" interval for events that take place less than one interval after the initial event.

unit

string

enum

The interval unit. It can be "day", "week", or "month". Default is "day".

Allowed:

unbounded_retention

boolean

Defaults to false

A counting method for retention queries where retention values accumulate from right to left, i.e. day N is equal to users who retained on day N and any day after. The default value of false does not perform this accumulation. Learn more about Counting Method.

string

The property expression to segment the second event on. See the expressions section above.

limit

integer

Return the top limit segmentation values. This parameter does nothing if "on" is not specified.

200Success.