Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-142201861.5 MB
Releases

Retrieve an Organization's Release

Return details on an individual release.

get/api/0/organizations/{organization_id_or_slug}/releases/{version}/

Path parameters

organization_id_or_slugstring required

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

versionstring required

The version identifier of the release

Query parameters

project_idstring

Deprecated. Use project instead.

integer
OR
string

The project ID or slug to filter by. Overrides project_id when both are sent.

healthboolean

Whether or not to include health data with the release. By default, this is false.

adoptionStagesboolean

Whether or not to include adoption stages with the release. By default, this is false.

summaryStatsPeriod'14d' | '1d' | '1h' | '24h' | '2d' | '30d' | '48h' | '7d' | '90d'

The period of time used to query summary stats for the release. By default, this is 14d.

healthStatsPeriod'14d' | '1d' | '1h' | '24h' | '2d' | '30d' | '48h' | '7d' | '90d'

The period of time used to query health stats for the release. By default, this is 24h if health is enabled.

sort'crash_free_sessions' | 'crash_free_users' | 'date' | 'sessions' | 'users'

The field used to sort results by. By default, this is date.

status'archived' | 'open'

Release statuses that you can filter by.

querystring

Filters results by using query syntax.

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

Response

refstring nullable
urlstring nullable
dateReleasedstring date-time nullable
dateCreatedstring date-time nullable
dateStartedstring date-time nullable
ownerobject nullable
lastCommitobject nullable
firstEventstring date-time nullable
lastEventstring date-time nullable
currentProjectMetaobject nullable
userAgentstring nullable
adoptionStagesobject nullable
idinteger required
versionstring required
newGroupsinteger required
statusstring required
shortVersionstring required
dataobject required
commitCountinteger required
deployCountinteger required