v1

latestOpenAPI 3.0.3Apache 2.02026-07-142201861.5 MB

Profiling

Retrieve a Flamegraph for an Organization

Retrieve an aggregated flamegraph for the organization, built from the requested data source (transactions, profiles, functions, or spans).

Pass expand=metrics to include aggregated function metrics in the response.

Requires profiling to be enabled for the organization.

get/api/0/organizations/{organization_id_or_slug}/profiling/flamegraph/

Path parameters

organization_id_or_slugstring required

The ID or slug of the organization the resource belongs to.

Query parameters

The IDs or slugs of projects to filter by. Project slugs are unique within each organization. Omit this parameter to include all accessible projects. -1 is also accepted to include all accessible projects. For example, the following are valid parameters:

/?project=1234&project=56789
/?project=android&project=javascript-react
/?project=-1

environmentstring[]

The name of environments to filter by.

statsPeriodstring

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.

startstring date-time

The start of the period of time for the query, expected in ISO-8601 format. For example, 2001-12-14T12:34:56.7890.

endstring date-time

The end of the period of time for the query, expected in ISO-8601 format. For example, 2001-12-14T12:34:56.7890.

dataSource'functions' | 'profiles' | 'spans' | 'transactions'

Source dataset to build the flamegraph from. Defaults to functions when fingerprint is set and transactions otherwise.

fingerprintinteger

A UInt32 function fingerprint. Only valid when dataSource=functions.

querystring

Sentry search syntax to filter the candidate profiles.

expandstring[]

Optional expansions. Pass metrics to include flamegraph metric aggregates in the response.

Response

object required