Retrieve Release Health Session Statistics

Go to Product
    Returns a time series of release health session statistics for projects bound to an "
    "organization.

The interval and date range are subject to certain restrictions and rounding " "rules.

The date range is rounded to align with the interval, and is rounded to at least one " "hour. The interval can at most be one day and at least one hour currently. It has to cleanly " "divide one day, for rounding reasons.

Because of technical limitations, this endpoint returns " "at most 10000 data points. For example, if you select a 90 day window grouped by releases, " "you will see at most floor(10k / (90 + 1)) = 109 releases. To get more results, reduce the " "statsPeriod."

Options

Organization Id or Slug
The ID or slug of the organization the resource belongs to.
Field

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](" "https://github.com/getsentry/sentry/discussions/42716) 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)
Start (*)
The start of the period of time for the query, expected in ISO-8601 format. For example 2001-12-14T12:34:56.7890.
End (*)
The end of the period of time for the query, expected in ISO-8601 format. For example 2001-12-14T12:34:56.7890.
Environment (*)
The name of environments to filter by.
Stats Period (*)

The period of time for the query, will override the start & end parameters, a number followed by one of:

  • d for days
  • h for hours
  • m for minutes
  • s for seconds
  • w for weeks

For example 24h, to mean query data starting from 24 hours ago to now.

Project (*)

The IDs of projects to filter by. -1 means all available projects. For example the following are valid parameters:

  • /?project=1234&project=56789
  • /?project=-1
Per Page (*)
The number of groups to return per request.
Interval (*)

Resolution of the time series, given in the same format as statsPeriod.

The default and the minimum interval is 1h.

Group By (*)

The list of properties to group by.

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

Order By (*)
An optional field to order by, which must be one of the fields provided in field. Use - for descending order, for example -sum(session)
Include Totals (*)
Specify 0 to exclude totals from the response. The default is 1
Include Series (*)
Specify 0 to exclude series from the response. The default is 1
Query (*)

Filters results by using query syntax.

example: query=(transaction:foo AND release:abc) OR (transaction:[bar,baz] AND release:def)

Result Format

Specify how the response should be mapped to the table output. The following formats are available:

Structured Table: Returns a parsed table with data split into rows and columns.

  • Start:
  • End:
  • Intervals:
  • Groups:
  • Query:

Raw Response: Returns the raw response in a single row with the following columns:

  • body: Response body
  • status: HTTP status code

Input Ports

Icon
Configuration data.

Output Ports

Icon
Result of the request depending on the selected Result Format.
Icon
Configuration data (this is the same as the input port; it is provided as passthrough for sequentially chaining nodes to declutter your workflow connections).

Popular Predecessors

  • No recommendations found

Popular Successors

  • No recommendations found

Views

This node has no views

Workflows

  • No workflows found

Links

Developers

You want to see the source code for this node? Click the following button and we’ll use our super-powers to find it for you.