Retrieve Release Health Session Statistics

Path Parameters

organization_slug (string)

REQUIRED

The slug of the organization.

Query Parameters:

project (array(integer))

REQUIRED

The ID of the projects to filter by.

Use -1 to include all accessible projects.

field (array(string))

REQUIRED

The list of fields to query.

The available fields are

• sum(session)
• count_unique(user)
• avg, p50, p75, p90, p95, p99, max applied to session.duration. For example, p99(session.duration). Session duration is no longer being recorded as of on Jan 12, 2023. Returned data may be incomplete.
• crash_rate, crash_free_rate applied to user or session. For example, crash_free_rate(user)

environment (array(string))

The name of environments to filter by.

groupBy (array(string))

The list of properties to group by.

The available groupBy conditions are project, release, environment and session.status.

Grouping by session.status does not work when crash_rate or crash_free_rate are queried.

orderBy (string)

An optional field to order by, which must be one of the fields provided in field. Use - for descending order, for example -sum(session).

This alters the order of the groups returned, so it only makes sense in combination with groupBy.

Ordering by more than one field is currently not supported.

query (string)

A free-form query that is applied as a filter.

An example query could be release:"1.1.0" or release:"1.2.0".

statsPeriod (string)

This defines the range of the time series, relative to now.

The range is given in a "<number><unit>" format.

For example 1d for a one day range. Possible units are m for minutes, h for hours, d for days and w for weeks.

It defaults to 90d.

interval (string)

This is the resolution of the time series, given in the same format as statsPeriod.

The default resolution is 1h and the minimum resolution is currently restricted to 1h as well.

Intervals larger than 1d are not supported, and the interval has to cleanly divide one day.

statsPeriodStart (string)

This defines the start of the time series range, in the same format as the interval, relative to now.

statsPeriodEnd (string)

This defines the end of the time series range, in the same format as the interval, relative to now.

start (string)

This defines the start of the time series range as an explicit datetime.

end (string)

This defines the inclusive end of the time series range as an explicit datetime.

Scopes

• org: read