> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # sentry-releases > Sentry Releases - manage releases, deploys, release files, health stats, and session replays **Server path:** `/sentry-releases` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [`sentry_releases_create_a_deploy`](#sentry_releases_create_a_deploy) | Create a deploy for a given release. | | [`sentry_releases_create_a_new_release_for_an_organization`](#sentry_releases_create_a_new_release_for_an_organization) | Create a new release for the given organization. Releases are used by Sentry to improve its error reporting abilities by correlating first seen events with the release that might have introduced the problem. Releases are also necessary for source maps and other debug features that require manual upload for functioning well. | | [`sentry_releases_delete_a_replay_instance`](#sentry_releases_delete_a_replay_instance) | Delete a replay. | | [`sentry_releases_delete_an_organization_s_release`](#sentry_releases_delete_an_organization_s_release) | Permanently remove a release and all of its files. | | [`sentry_releases_list_a_release_s_deploys`](#sentry_releases_list_a_release_s_deploys) | Returns a list of deploys based on the organization, version, and project. | | [`sentry_releases_list_an_organization_release_s_commits`](#sentry_releases_list_an_organization_release_s_commits) | List an organization release's commits. | | [`sentry_releases_list_an_organization_s_releases`](#sentry_releases_list_an_organization_s_releases) | Return a list of releases for a given organization. | | [`sentry_releases_list_an_organization_s_replays`](#sentry_releases_list_an_organization_s_replays) | Return a list of replays belonging to an organization. | | [`sentry_releases_list_an_organization_s_selectors`](#sentry_releases_list_an_organization_s_selectors) | Return a list of selectors for a given organization. | | [`sentry_releases_list_clicked_nodes`](#sentry_releases_list_clicked_nodes) | Retrieve a collection of RRWeb DOM node-ids and the timestamp they were clicked. | | [`sentry_releases_list_recording_segments`](#sentry_releases_list_recording_segments) | Return a collection of replay recording segments. | | [`sentry_releases_list_users_who_have_viewed_a_replay`](#sentry_releases_list_users_who_have_viewed_a_replay) | Return a list of users who have viewed a replay. | | [`sentry_releases_retrieve_a_count_of_replays_for_a_given_issue_or_transaction`](#sentry_releases_retrieve_a_count_of_replays_for_a_given_issue_or_transaction) | Return a count of replays for a list of issue or transaction IDs. The `query` parameter is required. It is a search query that includes exactly one of `issue.id`, `transaction`, or `replay_id` (string or list of strings). | | [`sentry_releases_retrieve_a_replay_instance`](#sentry_releases_retrieve_a_replay_instance) | Return details on an individual replay. | | [`sentry_releases_retrieve_an_organization_s_release`](#sentry_releases_retrieve_an_organization_s_release) | Return details on an individual release. | | [`sentry_releases_retrieve_files_changed_in_a_release_s_commits`](#sentry_releases_retrieve_files_changed_in_a_release_s_commits) | Retrieve files changed in a release's commits | | [`sentry_releases_retrieve_release_health_session_statistics`](#sentry_releases_retrieve_release_health_session_statistics) | 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`. | | [`sentry_releases_update_an_organization_s_release`](#sentry_releases_update_an_organization_s_release) | Update a release. This can change some metadata associated with the release (the ref, url, and dates). | *** ## sentry\_releases\_create\_a\_deploy Create a deploy for a given release. **Parameters:** | Parameter | Type | Required | Default | Description | | | ------------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | | `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. | | | `version` | string | Yes | — | The version identifier of the release | | | `dateFinished` | string | null | No | — | An optional date that indicates when the deploy ended. If not provided, the current time is used. | | `dateStarted` | string | null | No | — | An optional date that indicates when the deploy started | | `environment` | string | Yes | — | The environment you're deploying to | | | `name` | string | null | No | — | The optional name of the deploy | | `projects` | string\[] | No | — | The optional list of project slugs to create a deploy within. If not provided, deploys are created for all of the release's projects. | | | `url` | string | null | No | — | The optional URL that points to the deploy | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "organization_id_or_slug": { "type": "string", "description": "The ID or slug of the organization the resource belongs to." }, "version": { "type": "string", "description": "The version identifier of the release" }, "dateFinished": { "type": [ "string", "null" ], "description": "An optional date that indicates when the deploy ended. If not provided, the current time is used." }, "dateStarted": { "type": [ "string", "null" ], "description": "An optional date that indicates when the deploy started" }, "environment": { "type": "string", "description": "The environment you're deploying to" }, "name": { "type": [ "string", "null" ], "description": "The optional name of the deploy" }, "projects": { "type": "array", "items": { "type": "string" }, "description": "The optional list of project slugs to create a deploy within. If not provided, deploys are created for all of the release's projects." }, "url": { "type": [ "string", "null" ], "description": "The optional URL that points to the deploy" } }, "required": [ "PCID", "organization_id_or_slug", "version", "environment" ] } ``` *** ## sentry\_releases\_create\_a\_new\_release\_for\_an\_organization Create a new release for the given organization. Releases are used by Sentry to improve its error reporting abilities by correlating first seen events with the release that might have introduced the problem. Releases are also necessary for source maps and other debug features that require manual upload for functioning well. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization. | | `commits` | object\[] | No | — | An optional list of commit data to be associated with the release. Commits must include parameters `id` (the SHA of the commit), and can optionally include `repository`, `message`, `patch_set`, `author_name`, `author_email`, and `timestamp`. | | `dateReleased` | string | No | — | An optional date that indicates when the release went live. If not provided the current time is assumed. | | `projects` | string\[] | Yes | — | A list of project slugs that are involved in this release. | | `ref` | string | No | — | An optional commit reference. This is useful if a tagged version has been provided. | | `refs` | object\[] | No | — | An optional way to indicate the start and end commits for each repository included in a release. Head commits must include parameters `repository` and `commit` (the HEAD sha). They can optionally include `previousCommit` (the sha of the HEAD of the previous release), which should be specified if this is the first time you've sent commit data. `commit` may contain a range in the form of `previousCommit..commit`. | | `url` | string | No | — | A URL that points to the release. This can be the path to an online interface to the source code for instance | | `version` | string | Yes | — | A version identifier for this release. Can be a version number, a commit hash, etc. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "organization_id_or_slug": { "type": "string", "description": "The ID or slug of the organization." }, "commits": { "type": "array", "items": { "type": "object", "properties": { "patch_set": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string", "description": "The path to the file. Both forward and backward slashes are supported." }, "type": { "type": "string", "description": "The type of change that happened in the commit." } } }, "description": "A list of the files that have been changed in the commit. Specifying the patch_set is necessary to power suspect commits and suggested assignees." }, "repository": { "type": "string", "description": "The full name of the repository the commit belongs to. If this field is not given Sentry will generate a name in the form: u'organization-' (i.e. if the organization id is 123, then the generated repository name will be u'organization-123)." }, "author_name": { "type": "string", "description": "The name of the commit author." }, "author_email": { "type": "string", "description": "The email of the commit author. The commit author's email is required to enable the suggested assignee feature." }, "timestamp": { "type": "string", "format": "date-time", "description": "The commit timestamp is used to sort the commits given. If a timestamp is not included, the commits will remain sorted in the order given." }, "message": { "type": "string", "description": "The commit message." }, "id": { "type": "string", "description": "The commit ID (the commit SHA)." } } }, "description": "An optional list of commit data to be associated with the release. Commits must include parameters `id` (the SHA of the commit), and can optionally include `repository`, `message`, `patch_set`, `author_name`, `author_email`, and `timestamp`." }, "dateReleased": { "type": "string", "description": "An optional date that indicates when the release went live. If not provided the current time is assumed." }, "projects": { "type": "array", "items": { "type": "string" }, "description": "A list of project slugs that are involved in this release." }, "ref": { "type": "string", "description": "An optional commit reference. This is useful if a tagged version has been provided." }, "refs": { "type": "array", "items": { "type": "object", "properties": { "repository": { "type": "string", "description": "The full name of the repository the commit belongs to." }, "commit": { "type": "string", "description": "The current release's commit." }, "previousCommit": { "type": "string", "description": "The previous release's commit." } } }, "description": "An optional way to indicate the start and end commits for each repository included in a release. Head commits must include parameters `repository` and `commit` (the HEAD sha). They can optionally include `previousCommit` (the sha of the HEAD of the previous release), which should be specified if this is the first time you've sent commit data. `commit` may contain a range in the form of `previousCommit..commit`." }, "url": { "type": "string", "description": "A URL that points to the release. This can be the path to an online interface to the source code for instance" }, "version": { "type": "string", "description": "A version identifier for this release. Can be a version number, a commit hash, etc." } }, "required": [ "PCID", "organization_id_or_slug", "projects", "version" ] } ``` *** ## sentry\_releases\_delete\_a\_replay\_instance Delete a replay. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | ------ | -------- | ------- | ----------------------------------------------------------- | | `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. | | `project_id_or_slug` | string | Yes | — | The ID or slug of the project the resource belongs to. | | `replay_id` | string | Yes | — | The ID of the replay you'd like to retrieve. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "organization_id_or_slug": { "type": "string", "description": "The ID or slug of the organization the resource belongs to." }, "project_id_or_slug": { "type": "string", "description": "The ID or slug of the project the resource belongs to." }, "replay_id": { "type": "string", "description": "The ID of the replay you'd like to retrieve." } }, "required": [ "PCID", "organization_id_or_slug", "project_id_or_slug", "replay_id" ] } ``` *** ## sentry\_releases\_delete\_an\_organization\_s\_release Permanently remove a release and all of its files. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | ------ | -------- | ------- | ----------------------------------------------------------- | | `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. | | `version` | string | Yes | — | The version identifier of the release | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "organization_id_or_slug": { "type": "string", "description": "The ID or slug of the organization the resource belongs to." }, "version": { "type": "string", "description": "The version identifier of the release" } }, "required": [ "PCID", "organization_id_or_slug", "version" ] } ``` *** ## sentry\_releases\_list\_a\_release\_s\_deploys Returns a list of deploys based on the organization, version, and project. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------- | | `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. | | `version` | string | Yes | — | The version identifier of the release | | `cursor` | string | No | — | A pointer to the last object fetched and its sort order; used to retrieve the next or previous results. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "organization_id_or_slug": { "type": "string", "description": "The ID or slug of the organization the resource belongs to." }, "version": { "type": "string", "description": "The version identifier of the release" }, "cursor": { "type": "string", "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results." } }, "required": [ "PCID", "organization_id_or_slug", "version" ] } ``` *** ## sentry\_releases\_list\_an\_organization\_release\_s\_commits List an organization release's commits. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------- | | `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the release belongs to. | | `version` | string | Yes | — | The version identifier of the release. | | `cursor` | string | No | — | A pointer to the last object fetched and its sort order; used to retrieve the next or previous results. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "organization_id_or_slug": { "type": "string", "description": "The ID or slug of the organization the release belongs to." }, "version": { "type": "string", "description": "The version identifier of the release." }, "cursor": { "type": "string", "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results." } }, "required": [ "PCID", "organization_id_or_slug", "version" ] } ``` *** ## sentry\_releases\_list\_an\_organization\_s\_releases Return a list of releases for a given organization. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------- | | `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization. | | `query` | string | No | — | This parameter can be used to create a "starts with" filter for the version. | | `cursor` | string | No | — | A pointer to the last object fetched and its sort order; used to retrieve the next or previous results. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "organization_id_or_slug": { "type": "string", "description": "The ID or slug of the organization." }, "query": { "type": "string", "description": "This parameter can be used to create a \"starts with\" filter for the version." }, "cursor": { "type": "string", "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results." } }, "required": [ "PCID", "organization_id_or_slug" ] } ``` *** ## sentry\_releases\_list\_an\_organization\_s\_replays Return a list of replays belonging to an organization. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | ---------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. | | `statsPeriod` | string | No | — | 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. You must either provide a `statsPeriod`, or a `start` and `end`. | | `start` | string | No | — | This defines the start of the time series range as an explicit datetime, either in UTC ISO8601 or epoch seconds. Use along with `end` instead of `statsPeriod`. | | `end` | string | No | — | This defines the inclusive end of the time series range as an explicit datetime, either in UTC ISO8601 or epoch seconds. Use along with `start` instead of `statsPeriod`. | | `field` | string\[] | No | — | Specifies a field that should be marshaled in the output. Invalid fields will be rejected. | | `project` | integer\[] | No | — | The ID of the projects to filter by. | | `projectSlug` | string\[] | No | — | A list of project slugs to filter your results by. | | `environment` | string | No | — | The environment to filter by. | | `sort` | string | No | — | The field to sort the output by. | | `sortBy` | string | No | — | The field to sort the output by. | | `orderBy` | string | No | — | The field to sort the output by. | | `query` | string | No | — | A structured query string to filter the output by. | | `per_page` | integer | No | — | Limit the number of rows to return in the result. | | `cursor` | string | No | — | The cursor parameter is used to paginate results. See [here](https://docs.sentry.io/api/pagination/) for how to use this query parameter | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "organization_id_or_slug": { "type": "string", "description": "The ID or slug of the organization the resource belongs to." }, "statsPeriod": { "type": "string", "description": "This defines the range of the time series, relative to now. The range is given in a `` 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. You must either provide a `statsPeriod`, or a `start` and `end`." }, "start": { "type": "string", "description": "This defines the start of the time series range as an explicit datetime, either in UTC ISO8601 or epoch seconds. Use along with `end` instead of `statsPeriod`." }, "end": { "type": "string", "description": "This defines the inclusive end of the time series range as an explicit datetime, either in UTC ISO8601 or epoch seconds. Use along with `start` instead of `statsPeriod`." }, "field": { "type": "array", "items": { "type": "string", "enum": [ "activity", "browser", "count_dead_clicks", "count_errors", "count_rage_clicks", "count_segments", "count_urls", "device", "dist", "duration", "environment", "error_ids", "finished_at", "id", "is_archived", "os", "platform", "project_id", "releases", "sdk", "started_at", "tags", "trace_ids", "urls", "user", "clicks", "info_ids", "warning_ids", "count_warnings", "count_infos", "has_viewed" ] }, "description": "Specifies a field that should be marshaled in the output. Invalid fields will be rejected." }, "project": { "type": "array", "items": { "type": "integer" }, "description": "The ID of the projects to filter by." }, "projectSlug": { "type": "array", "items": { "type": "string" }, "description": "A list of project slugs to filter your results by." }, "environment": { "type": "string", "description": "The environment to filter by." }, "sort": { "type": "string", "description": "The field to sort the output by." }, "sortBy": { "type": "string", "description": "The field to sort the output by." }, "orderBy": { "type": "string", "description": "The field to sort the output by." }, "query": { "type": "string", "description": "A structured query string to filter the output by." }, "per_page": { "type": "integer", "description": "Limit the number of rows to return in the result." }, "cursor": { "type": "string", "description": "The cursor parameter is used to paginate results. See [here](https://docs.sentry.io/api/pagination/) for how to use this query parameter" } }, "required": [ "PCID", "organization_id_or_slug" ] } ``` *** ## sentry\_releases\_list\_an\_organization\_s\_selectors Return a list of selectors for a given organization. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | ---------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. | | `environment` | string\[] | No | — | The environment to filter by. | | `statsPeriod` | string | No | — | 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.You must either provide a `statsPeriod`, or a `start` and `end`. | | `start` | string | No | — | This defines the start of the time series range as an explicit datetime, either in UTC ISO8601 or epoch seconds.Use along with `end` instead of `statsPeriod`. | | `end` | string | No | — | This defines the inclusive end of the time series range as an explicit datetime, either in UTC ISO8601 or epoch seconds.Use along with `start` instead of `statsPeriod`. | | `project` | integer\[] | No | — | The ID of the projects to filter by. | | `projectSlug` | string\[] | No | — | A list of project slugs to filter your results by. | | `sort` | string | No | — | The field to sort the output by. | | `sortBy` | string | No | — | The field to sort the output by. | | `orderBy` | string | No | — | The field to sort the output by. | | `cursor` | string | No | — | A pointer to the last object fetched and its sort order; used to retrieve the next or previous results. | | `per_page` | integer | No | — | Limit the number of rows to return in the result. Default and maximum allowed is 100. | | `query` | string | No | — | Filters results by using query syntax. Example: `query=(transaction:foo AND release:abc) OR (transaction:[bar,baz] AND release:def)` | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "organization_id_or_slug": { "type": "string", "description": "The ID or slug of the organization the resource belongs to." }, "environment": { "type": "array", "items": { "type": "string" }, "description": "The environment to filter by." }, "statsPeriod": { "type": "string", "description": "This defines the range of the time series, relative to now. The range is given in a `` 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.You must either provide a `statsPeriod`, or a `start` and `end`." }, "start": { "type": "string", "description": "This defines the start of the time series range as an explicit datetime, either in UTC ISO8601 or epoch seconds.Use along with `end` instead of `statsPeriod`." }, "end": { "type": "string", "description": "This defines the inclusive end of the time series range as an explicit datetime, either in UTC ISO8601 or epoch seconds.Use along with `start` instead of `statsPeriod`." }, "project": { "type": "array", "items": { "type": "integer" }, "description": "The ID of the projects to filter by." }, "projectSlug": { "type": "array", "items": { "type": "string" }, "description": "A list of project slugs to filter your results by." }, "sort": { "type": "string", "description": "The field to sort the output by." }, "sortBy": { "type": "string", "description": "The field to sort the output by." }, "orderBy": { "type": "string", "description": "The field to sort the output by." }, "cursor": { "type": "string", "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results." }, "per_page": { "type": "integer", "description": "Limit the number of rows to return in the result. Default and maximum allowed is 100." }, "query": { "type": "string", "description": "Filters results by using [query syntax](/product/sentry-basics/search/). Example: `query=(transaction:foo AND release:abc) OR (transaction:[bar,baz] AND release:def)`" } }, "required": [ "PCID", "organization_id_or_slug" ] } ``` *** ## sentry\_releases\_list\_clicked\_nodes Retrieve a collection of RRWeb DOM node-ids and the timestamp they were clicked. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------- | | `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. | | `project_id_or_slug` | string | Yes | — | The ID or slug of the project the resource belongs to. | | `replay_id` | string | Yes | — | The ID of the replay you'd like to retrieve. | | `cursor` | string | No | — | A pointer to the last object fetched and its sort order; used to retrieve the next or previous results. | | `environment` | string\[] | No | — | The name of environments to filter by. | | `per_page` | integer | No | — | Limit the number of rows to return in the result. Default and maximum allowed is 100. | | `query` | string | No | — | Filters results by using query syntax. Example: `query=(transaction:foo AND release:abc) OR (transaction:[bar,baz] AND release:def)` | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "organization_id_or_slug": { "type": "string", "description": "The ID or slug of the organization the resource belongs to." }, "project_id_or_slug": { "type": "string", "description": "The ID or slug of the project the resource belongs to." }, "replay_id": { "type": "string", "description": "The ID of the replay you'd like to retrieve." }, "cursor": { "type": "string", "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results." }, "environment": { "type": "array", "items": { "type": "string" }, "description": "The name of environments to filter by." }, "per_page": { "type": "integer", "description": "Limit the number of rows to return in the result. Default and maximum allowed is 100." }, "query": { "type": "string", "description": "Filters results by using [query syntax](/product/sentry-basics/search/). Example: `query=(transaction:foo AND release:abc) OR (transaction:[bar,baz] AND release:def)`" } }, "required": [ "PCID", "organization_id_or_slug", "project_id_or_slug", "replay_id" ] } ``` *** ## sentry\_releases\_list\_recording\_segments Return a collection of replay recording segments. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------- | | `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. | | `project_id_or_slug` | string | Yes | — | The ID or slug of the project the resource belongs to. | | `replay_id` | string | Yes | — | The ID of the replay you'd like to retrieve. | | `cursor` | string | No | — | A pointer to the last object fetched and its sort order; used to retrieve the next or previous results. | | `per_page` | integer | No | — | Limit the number of rows to return in the result. Default and maximum allowed is 100. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "organization_id_or_slug": { "type": "string", "description": "The ID or slug of the organization the resource belongs to." }, "project_id_or_slug": { "type": "string", "description": "The ID or slug of the project the resource belongs to." }, "replay_id": { "type": "string", "description": "The ID of the replay you'd like to retrieve." }, "cursor": { "type": "string", "description": "A pointer to the last object fetched and its sort order; used to retrieve the next or previous results." }, "per_page": { "type": "integer", "description": "Limit the number of rows to return in the result. Default and maximum allowed is 100." } }, "required": [ "PCID", "organization_id_or_slug", "project_id_or_slug", "replay_id" ] } ``` *** ## sentry\_releases\_list\_users\_who\_have\_viewed\_a\_replay Return a list of users who have viewed a replay. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | ------ | -------- | ------- | ----------------------------------------------------------- | | `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. | | `project_id_or_slug` | string | Yes | — | The ID or slug of the project the resource belongs to. | | `replay_id` | string | Yes | — | The ID of the replay you'd like to retrieve. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "organization_id_or_slug": { "type": "string", "description": "The ID or slug of the organization the resource belongs to." }, "project_id_or_slug": { "type": "string", "description": "The ID or slug of the project the resource belongs to." }, "replay_id": { "type": "string", "description": "The ID of the replay you'd like to retrieve." } }, "required": [ "PCID", "organization_id_or_slug", "project_id_or_slug", "replay_id" ] } ``` *** ## sentry\_releases\_retrieve\_a\_count\_of\_replays\_for\_a\_given\_issue\_or\_transaction Return a count of replays for a list of issue or transaction IDs. The `query` parameter is required. It is a search query that includes exactly one of `issue.id`, `transaction`, or `replay_id` (string or list of strings). **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. | | `environment` | string\[] | No | — | The name of environments to filter by. | | `start` | string | No | — | The start of the period of time for the query, expected in ISO-8601 format. For example, `2001-12-14T12:34:56.7890`. | | `end` | string | No | — | The end of the period of time for the query, expected in ISO-8601 format. For example, `2001-12-14T12:34:56.7890`. | | `statsPeriod` | string | No | — | 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_id_or_slug` | string\[] | No | — | The project slugs to filter by. Use `$all` to include all available projects. For example, the following are valid parameters: - `/?projectSlug=$all` - `/?projectSlug=android&projectSlug=javascript-react` | | `query` | string | No | — | Filters results by using query syntax. Example: `query=(transaction:foo AND release:abc) OR (transaction:[bar,baz] AND release:def)` | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "organization_id_or_slug": { "type": "string", "description": "The ID or slug of the organization the resource belongs to." }, "environment": { "type": "array", "items": { "type": "string" }, "description": "The name of environments to filter by." }, "start": { "type": "string", "description": "The start of the period of time for the query, expected in ISO-8601 format. For example, `2001-12-14T12:34:56.7890`." }, "end": { "type": "string", "description": "The end of the period of time for the query, expected in ISO-8601 format. For example, `2001-12-14T12:34:56.7890`." }, "statsPeriod": { "type": "string", "description": "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_id_or_slug": { "type": "array", "items": { "type": "string" }, "description": "The project slugs to filter by. Use `$all` to include all available projects. For example, the following are valid parameters: - `/?projectSlug=$all` - `/?projectSlug=android&projectSlug=javascript-react`" }, "query": { "type": "string", "description": "Filters results by using [query syntax](/product/sentry-basics/search/). Example: `query=(transaction:foo AND release:abc) OR (transaction:[bar,baz] AND release:def)`" } }, "required": [ "PCID", "organization_id_or_slug" ] } ``` *** ## sentry\_releases\_retrieve\_a\_replay\_instance Return details on an individual replay. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | ---------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. | | `replay_id` | string | Yes | — | The ID of the replay you'd like to retrieve. | | `statsPeriod` | string | No | — | 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. You must either provide a `statsPeriod`, or a `start` and `end`. | | `start` | string | No | — | This defines the start of the time series range as an explicit datetime, either in UTC ISO8601 or epoch seconds. Use along with `end` instead of `statsPeriod`. | | `end` | string | No | — | This defines the inclusive end of the time series range as an explicit datetime, either in UTC ISO8601 or epoch seconds. Use along with `start` instead of `statsPeriod`. | | `field` | string\[] | No | — | Specifies a field that should be marshaled in the output. Invalid fields will be rejected. | | `project` | integer\[] | No | — | The ID of the projects to filter by. | | `projectSlug` | string\[] | No | — | A list of project slugs to filter your results by. | | `environment` | string | No | — | The environment to filter by. | | `sort` | string | No | — | The field to sort the output by. | | `sortBy` | string | No | — | The field to sort the output by. | | `orderBy` | string | No | — | The field to sort the output by. | | `query` | string | No | — | A structured query string to filter the output by. | | `per_page` | integer | No | — | Limit the number of rows to return in the result. | | `cursor` | string | No | — | The cursor parameter is used to paginate results. See [here](https://docs.sentry.io/api/pagination/) for how to use this query parameter | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "organization_id_or_slug": { "type": "string", "description": "The ID or slug of the organization the resource belongs to." }, "replay_id": { "type": "string", "description": "The ID of the replay you'd like to retrieve." }, "statsPeriod": { "type": "string", "description": "This defines the range of the time series, relative to now. The range is given in a `` 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. You must either provide a `statsPeriod`, or a `start` and `end`." }, "start": { "type": "string", "description": "This defines the start of the time series range as an explicit datetime, either in UTC ISO8601 or epoch seconds. Use along with `end` instead of `statsPeriod`." }, "end": { "type": "string", "description": "This defines the inclusive end of the time series range as an explicit datetime, either in UTC ISO8601 or epoch seconds. Use along with `start` instead of `statsPeriod`." }, "field": { "type": "array", "items": { "type": "string", "enum": [ "activity", "browser", "count_dead_clicks", "count_errors", "count_rage_clicks", "count_segments", "count_urls", "device", "dist", "duration", "environment", "error_ids", "finished_at", "id", "is_archived", "os", "platform", "project_id", "releases", "sdk", "started_at", "tags", "trace_ids", "urls", "user", "clicks", "info_ids", "warning_ids", "count_warnings", "count_infos", "has_viewed" ] }, "description": "Specifies a field that should be marshaled in the output. Invalid fields will be rejected." }, "project": { "type": "array", "items": { "type": "integer" }, "description": "The ID of the projects to filter by." }, "projectSlug": { "type": "array", "items": { "type": "string" }, "description": "A list of project slugs to filter your results by." }, "environment": { "type": "string", "description": "The environment to filter by." }, "sort": { "type": "string", "description": "The field to sort the output by." }, "sortBy": { "type": "string", "description": "The field to sort the output by." }, "orderBy": { "type": "string", "description": "The field to sort the output by." }, "query": { "type": "string", "description": "A structured query string to filter the output by." }, "per_page": { "type": "integer", "description": "Limit the number of rows to return in the result." }, "cursor": { "type": "string", "description": "The cursor parameter is used to paginate results. See [here](https://docs.sentry.io/api/pagination/) for how to use this query parameter" } }, "required": [ "PCID", "organization_id_or_slug", "replay_id" ] } ``` *** ## sentry\_releases\_retrieve\_an\_organization\_s\_release Return details on an individual release. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------- | | `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. | | `version` | string | Yes | — | The version identifier of the release | | `project_id` | string | No | — | The project ID to filter by. | | `health` | boolean | No | — | Whether or not to include health data with the release. By default, this is false. | | `adoptionStages` | boolean | No | — | Whether or not to include adoption stages with the release. By default, this is false. | | `summaryStatsPeriod` | string | No | — | The period of time used to query summary stats for the release. By default, this is 14d. | | `healthStatsPeriod` | string | No | — | The period of time used to query health stats for the release. By default, this is 24h if health is enabled. | | `sort` | string | No | — | The field used to sort results by. By default, this is `date`. | | `status` | string | No | — | Release statuses that you can filter by. | | `query` | string | No | — | Filters results by using query syntax. Example: `query=(transaction:foo AND release:abc) OR (transaction:[bar,baz] AND release:def)` | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "organization_id_or_slug": { "type": "string", "description": "The ID or slug of the organization the resource belongs to." }, "version": { "type": "string", "description": "The version identifier of the release" }, "project_id": { "type": "string", "description": "The project ID to filter by." }, "health": { "type": "boolean", "description": "Whether or not to include health data with the release. By default, this is false." }, "adoptionStages": { "type": "boolean", "description": "Whether or not to include adoption stages with the release. By default, this is false." }, "summaryStatsPeriod": { "type": "string", "description": "The period of time used to query summary stats for the release. By default, this is 14d.", "enum": [ "14d", "1d", "1h", "24h", "2d", "30d", "48h", "7d", "90d" ] }, "healthStatsPeriod": { "type": "string", "description": "The period of time used to query health stats for the release. By default, this is 24h if health is enabled.", "enum": [ "14d", "1d", "1h", "24h", "2d", "30d", "48h", "7d", "90d" ] }, "sort": { "type": "string", "description": "The field used to sort results by. By default, this is `date`.", "enum": [ "crash_free_sessions", "crash_free_users", "date", "sessions", "users" ] }, "status": { "type": "string", "description": "Release statuses that you can filter by.", "enum": [ "archived", "open" ] }, "query": { "type": "string", "description": "Filters results by using [query syntax](/product/sentry-basics/search/). Example: `query=(transaction:foo AND release:abc) OR (transaction:[bar,baz] AND release:def)`" } }, "required": [ "PCID", "organization_id_or_slug", "version" ] } ``` *** ## sentry\_releases\_retrieve\_files\_changed\_in\_a\_release\_s\_commits Retrieve files changed in a release's commits **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | ------ | -------- | ------- | ---------------------------------------------------------- | | `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the release belongs to. | | `version` | string | Yes | — | The version identifier of the release. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "organization_id_or_slug": { "type": "string", "description": "The ID or slug of the organization the release belongs to." }, "version": { "type": "string", "description": "The version identifier of the release." } }, "required": [ "PCID", "organization_id_or_slug", "version" ] } ``` *** ## sentry\_releases\_retrieve\_release\_health\_session\_statistics 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`. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | ---------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. | | `field` | string\[] | Yes | — | 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` | string | No | — | The start of the period of time for the query, expected in ISO-8601 format. For example, `2001-12-14T12:34:56.7890`. | | `end` | string | No | — | The end of the period of time for the query, expected in ISO-8601 format. For example, `2001-12-14T12:34:56.7890`. | | `environment` | string\[] | No | — | The name of environments to filter by. | | `statsPeriod` | string | No | — | 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` | integer\[] | No | — | 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` | integer | No | — | The number of groups to return per request. | | `interval` | string | No | — | Resolution of the time series, given in the same format as `statsPeriod`. The default and the minimum interval is `1h`. | | `groupBy` | string\[] | No | — | The list of properties to group by. The available groupBy conditions are `project`, `release`, `environment` and `session.status`. | | `orderBy` | string | No | — | An optional field to order by, which must be one of the fields provided in `field`. Use `-` for descending order, for example, `-sum(session)` | | `includeTotals` | integer | No | — | Specify `0` to exclude totals from the response. The default is `1` | | `includeSeries` | integer | No | — | Specify `0` to exclude series from the response. The default is `1` | | `query` | string | No | — | Filters results by using query syntax. Example: `query=(transaction:foo AND release:abc) OR (transaction:[bar,baz] AND release:def)` | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "organization_id_or_slug": { "type": "string", "description": "The ID or slug of the organization the resource belongs to." }, "field": { "type": "array", "items": { "type": "string" }, "description": "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": { "type": "string", "description": "The start of the period of time for the query, expected in ISO-8601 format. For example, `2001-12-14T12:34:56.7890`." }, "end": { "type": "string", "description": "The end of the period of time for the query, expected in ISO-8601 format. For example, `2001-12-14T12:34:56.7890`." }, "environment": { "type": "array", "items": { "type": "string" }, "description": "The name of environments to filter by." }, "statsPeriod": { "type": "string", "description": "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": { "type": "array", "items": { "type": "integer" }, "description": "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": { "type": "integer", "description": "The number of groups to return per request." }, "interval": { "type": "string", "description": "Resolution of the time series, given in the same format as `statsPeriod`. The default and the minimum interval is `1h`." }, "groupBy": { "type": "array", "items": { "type": "string" }, "description": "The list of properties to group by. The available groupBy conditions are `project`, `release`, `environment` and `session.status`." }, "orderBy": { "type": "string", "description": "An optional field to order by, which must be one of the fields provided in `field`. Use `-` for descending order, for example, `-sum(session)`" }, "includeTotals": { "type": "integer", "description": "Specify `0` to exclude totals from the response. The default is `1`" }, "includeSeries": { "type": "integer", "description": "Specify `0` to exclude series from the response. The default is `1`" }, "query": { "type": "string", "description": "Filters results by using [query syntax](/product/sentry-basics/search/). Example: `query=(transaction:foo AND release:abc) OR (transaction:[bar,baz] AND release:def)`" } }, "required": [ "PCID", "organization_id_or_slug", "field" ] } ``` *** ## sentry\_releases\_update\_an\_organization\_s\_release Update a release. This can change some metadata associated with the release (the ref, url, and dates). **Parameters:** | Parameter | Type | Required | Default | Description | | | ------------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | | `organization_id_or_slug` | string | Yes | — | The ID or slug of the organization the resource belongs to. | | | `version` | string | Yes | — | The version identifier of the release | | | `commits` | object\[] | No | — | An optional list of commit data to be associated. | | | `dateReleased` | string | null | No | — | An optional date that indicates when the release went live. If not provided the current time is used. | | `ref` | string | null | No | — | An optional commit reference. This is useful if a tagged version has been provided. | | `refs` | object\[] | No | — | An optional way to indicate the start and end commits for each repository included in a release. Head commits must include parameters `repository` and `commit` (the HEAD SHA). For GitLab repositories, please use the Group name instead of the slug. They can optionally include `previousCommit` (the SHA of the HEAD of the previous release), which should be specified if this is the first time you've sent commit data. | | | `url` | string | null | No | — | A URL that points to the release. For instance, this can be the path to an online interface to the source code, such as a GitHub URL. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "organization_id_or_slug": { "type": "string", "description": "The ID or slug of the organization the resource belongs to." }, "version": { "type": "string", "description": "The version identifier of the release" }, "commits": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The id value" }, "repository": { "type": "string", "description": "The repository value" }, "message": { "type": "string", "description": "The message value" }, "author_name": { "type": "string", "description": "Author Name" }, "author_email": { "type": "string", "description": "Author Email" }, "timestamp": { "type": "string", "format": "date-time", "description": "The timestamp value" }, "patch_set": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "type": { "type": "string" } } }, "description": "Patch Set" } }, "required": [ "id" ] }, "description": "An optional list of commit data to be associated." }, "dateReleased": { "type": [ "string", "null" ], "description": "An optional date that indicates when the release went live. If not provided the current time is used." }, "ref": { "type": [ "string", "null" ], "description": "An optional commit reference. This is useful if a tagged version has been provided." }, "refs": { "type": "array", "items": { "type": "object", "properties": { "commit": { "type": "string", "description": "The commit value" }, "repository": { "type": "string", "description": "The repository value" }, "previousCommit": { "type": "string", "description": "Previous Commit" } }, "required": [ "commit", "repository" ] }, "description": "An optional way to indicate the start and end commits for each repository included in a release. Head commits must include parameters ``repository`` and ``commit`` (the HEAD SHA). For GitLab repositories, please use the Group name instead of the slug. They can optionally include ``previousCommit`` (the SHA of the HEAD of the previous release), which should be specified if this is the first time you've sent commit data." }, "url": { "type": [ "string", "null" ], "description": "A URL that points to the release. For instance, this can be the path to an online interface to the source code, such as a GitHub URL." } }, "required": [ "PCID", "organization_id_or_slug", "version" ] } ```