Get Started
- Introduction
- Quickstart
Documentation
- Data Sources
- Business Objects
- Business Graph™
- Knowledge
- Query Agent
- Reports
- Subscriptions
- Destinations
- Tools
- Introduction
- Ably
- Acculynx
- Active campaign
- Affinity
- Agencyzoom
- Ahrefs
- Airtable
- Alchemy
- Amplitude
- Apaleo
- Apollo
- Asana
- Attio
- Bamboohr
- Bannerbear
- Baserow
- Bill
- Bitbucket
- Blackboard
- Bolna
- Borneo
- Box
- Brevo
- Browseai
- Browserbase tool
- Bugbug
- Cal
- Calendly
- Canva
- Canvas
- Chatwork
- Clickup
- Coda
- Codeinterpreter
- Coinbase
- Composio
- Composio search
- Confluence
- Contentful
- Crustdata
- D2lbrightspace
- Dialpad
- Discord
- Discordbot
- Docusign
- Dropbox
- Dynamics365
- Echtpost
- Elevenlabs
- Entelligence
- Exa
- Excel
- Figma
- Firecrawl
- Fireflies
- Flutterwave
- Formsite
- Foursquare
- Freshdesk
- Github
- Gmail
- Gong
- Google maps
- Googleads
- Googlebigquery
- Googlecalendar
- Googledocs
- Googledrive
- Googlemeet
- Googlephotos
- Googlesheets
- Googlesuper
- Googletasks
- Gorgias
- Hackernews
- Heygen
- Hubspot
- Humanloop
- Intercom
- Jira
- Junglescout
- Klaviyo
- Kommo
- Linear
- Linkedin
- Linkhut
- Linkup
- Listennotes
- Lmnt
- Mailchimp
- Mem0
- Metaads
- Microsoft clarity
- Microsoft teams
- Mixpanel
- Monday
- More trees
- Neon
- Ngrok
- Notion
- One drive
- Onepage
- Open sea
- Outlook
- Pagerduty
- Pandadoc
- Peopledatalabs
- Perplexityai
- Pipedrive
- Placekey
- Posthog
- Quickbooks
- Ramp
- Recallai
- Reddit
- Resend
- Retellai
- Rocketlane
- Rootly
- Salesforce
- Semanticscholar
- Semrush
- Sendgrid
- Sentry
- Serpapi
- Servicenow
- Share point
- Shopify
- Shortcut
- Simplesat
- Slack
- Slack user
- Slackbot
- Snowflake
- Stripe
- Supabase
- Tavily
- Text to pdf
- Textrazor
- Tinyurl
- Todoist
- Trello
- Twitter
- Twitter media
- Typefully
- Weathermap
- Webflow
- Whatsapp
- Workiom
- Wrike
- Yousearch
- Youtube
- Zendesk
- Zenrows
- Zoho
- Zoom
- Zoominfo
- Admin
Changelog
Sentry
Integrate Sentry to manage your error tracking and monitoring.
Link a user from an external provider to a sentry user.
Delete a debug information file for a given project.
Create a new client key bound to a project. the key’s secret and public key are generated by the server.
Create a new team bound to an organization. requires at least one of the name
or slug
body params to be set.
Create a new dashboard for the given organization
Delete an organization’s custom dashboard, or tombstone a pre-built dashboard which effectively deletes it.
Create a new metric alert rule for the given organization. a metric alert rule defines conditions for triggering alerts based on metrics like error count, latency, or failure rate. it specifies the metric type, function, time interval, and thresholds that determine when to trigger alerts. this helps proactively identify and address issues in your project.
Create a new monitor.
Return details on an individual project.
Create a new organization member via a scim users post request. note that this api does not support setting secondary emails.
Permanently remove a release and all of its files.
Create a new issue alert rule for the given project. an issue alert rule triggers whenever a new event is received for any issue in a project that matches the specified alert conditions. these conditions can include a resolved issue re-appearing or an issue affecting many users. alert conditions have three parts: - triggers: specify what type of activity you’d like monitored or when an alert should be triggered. - filters: help control noise by triggering an alert only if the issue matches the specified criteria. - actions: specify what should happen when the trigger conditions are met and the filters match.
Delete a saved query.
Delete an external issue.
Schedules a project for deletion. deletion happens asynchronously and therefore is not immediate. however once deletion has begun the state of a project changes and will be hidden from most public views.
Remove a service hook.
Delete a client key for a given project.
Delete the link between a team from an external provider and a sentry team.
Add or invite a member to an organization.
Deletes a spike protection notification action. notification actions notify a set of members when an action has been triggered through a notification service such as slack or sentry. for example, organization owners and managers can receive an email when a spike occurs.
Register a new service hook on a project. events include: - event.alert: an alert is generated for an event (via rules). - event.created: a new event has been processed. this endpoint requires the ‘servicehooks’ feature to be enabled for your project.
Schedules a team for deletion. note: deletion happens asynchronously and therefore is not immediate. teams will have their slug released while waiting for deletion.
Add a secondary email address to account
Permanently remove the given issues. the list of issues to modify is given through the id
query parameter. it is repeated for each issue that should be removed. only queries by ‘id’ are accepted. if any ids are out of scope this operation will succeed without any data mutation.
Delete the link between a user from an external provider and a sentry user.
Delete a file for a given release.
Revoke a team’s access to a project. note that team admins can only revoke access to teams they are admins of.
Delete a team with a scim group delete request.
Delete an organization member from a team.
Delete a file for a given release.
Retrieves the details of an issue event.
Delete an organization member with a scim user delete request.
Removes an email associated with the user account
Delete a monitor or monitor environments.
Add an organization member to a team.
Organizationintegrationbaseendpoints expect both integration and organizationintegration db entries to exist for a given organization and integration id.
Give a team access to a project.
Return a count of replays for the given issue or transaction id.
Delete a specific metric alert rule. a metric alert rule is a configuration that defines the conditions for triggering an alert. it specifies the metric type, function, time interval, and threshold values that determine when an alert should be triggered. metric alert rules are used to monitor and notify you when certain metrics, like error count, latency, or failure rate, cross a predefined threshold. these rules help you proactively identify and address issues in your project.
Return details on a project environment.
[warning]
: this api is an experimental alpha feature and is subject to change! list all derived statuses of releases that fall within the provided start/end datetimes. constructs a response key’d off {release version
}-{project slug
} that lists thresholds with their status for specified projects. each returned enriched threshold will contain the full serialized release threshold
instance as well as it’s derived health statuses.
Return a list of files for a given release.
Return a replay recording segment.
Create a deploy.
Returns a list of values associated with this key for an issue. returns at most 1000 values when paginated.
Return a list of activations for a metric alert rule. an activation represents a single instance of an activated alert rule being triggered. it contains a date added field which represents the time the alert was triggered. activations can be filtered by start and end parameters to return activations with date added that falls within the specified time window.
Delete a specific issue alert rule.
Organizationintegrationbaseendpoints expect both integration and organizationintegration db entries to exist for a given organization and integration id.
Delete a replay.
Return a list of active metric alert rules bound to an organization. a metric alert rule is a configuration that defines the conditions for triggering an alert. it specifies the metric type, function, time interval, and threshold values that determine when an alert should be triggered. metric alert rules are used to monitor and notify you when certain metrics, like error count, latency, or failure rate, cross a predefined threshold. these rules help you proactively identify and address issues in your project.
Returns details on a project’s ownership configuration.
Return a list of selectors for a given organization.
Create or update an external issue from an integration platform integration.
Create a new project bound to a team.
Delete a monitor or monitor environments.
Delete a custom symbol source from a project.
Return details on an individual replay.
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.
Retrieve a collection of rrweb dom node-ids and the timestamp they were clicked.
Remove an organization member.
Removes an individual issue.
Create a new team bound to an organization via a scim groups post request. the slug will have a normalization of uppercases/spaces to lowercases and dashes. note that teams are always created with an empty member set.
Retrieves details for a monitor.
Lists an organization’s environments.
Return a list of organizations available to the authenticated session in a region. this is particularly useful for requests with a user bound context. for api key-based requests this will only return the organization that belongs to the key.
Returns a list of teams the user has access to in the specified organization. note that this endpoint is restricted to user auth tokens.
Return details on an individual release.
Return a list of projects available to the authenticated session.
Return a list of events bound to a project.
Return details on an individual organization, including various details such as membership access and teams.
Return details on an individual issue. this returns the basic stats for the issue (title, last seen, first seen), some overall numbers (number of comments, user reports) as well as the summarized event data.
Retrieve a list of check-ins for a monitor
Returns a serialized spike protection notification action object. notification actions notify a set of members when an action has been triggered through a notification service such as slack or sentry. for example, organization owners and managers can receive an email when a spike occurs.
Return a list of values associated with this key for an issue. when paginated can return at most 1000 values.
Retrieve a list of check-ins for a monitor
Return a list of error events bound to an issue
Update an organization member’s attributes with a scim patch request.
Retrieves details for a monitor.
This endpoint lists an issue’s hashes, which are the generated checksums used to aggregate individual events.
Return a list of trusted relays bound to an organization. if the organization doesn’t have relay usage enabled it returns a 404.
Return details on an individual event.
Return a list of users seen within this project.
List an organization release’s commits.
Retrieve a file for a given release.
Query an individual team with a scim group get request. - note that the members field will only contain up to 10000 members.
Return a list of service hooks bound to a project.
Returns a list of teams bound to a organization.
Retrieve a list of filters for a given project. active
will be either a boolean or a list for the legacy browser filters.
Add a custom symbol source to a project.
Returns a list of active organization members that belong to any team assigned to the project.
Return a list of client keys bound to a project.
Return details about an organization’s custom dashboard.
Return details on an individual issue alert rule. an issue alert rule triggers whenever a new event is received for any issue in a project that matches the specified alert conditions. these conditions can include a resolved issue re-appearing or an issue affecting many users. alert conditions have three parts: - triggers - specify what type of activity you’d like monitored or when an alert should be triggered. - filters - help control noise by triggering an alert only if the issue matches the specified criteria. - actions - specify what should happen when the trigger conditions are met and the filters match.
Return a client key bound to a project.
Returns a paginated list of members bound to a organization with a scim users get request.
Return a list of issues (groups) bound to a project. all parameters are supplied as query string parameters. a default query of is:unresolved
is applied. to return results with other statuses send an new query value (i.e. ?query=
for all results). the statsperiod
parameter can be used to select the timeline stats which should be present. possible values are: ""
(disable),"24h"
(default), "14d"
user feedback items from the user feedback widget are built off the issue platform, so to return a list of user feedback items for a specific project, filter for issue.category:feedback
.
Return a list of active issue alert rules bound to a project. an issue alert rule triggers whenever a new event is received for any issue in a project that matches the specified alert conditions. these conditions can include a resolved issue re-appearing or an issue affecting many users. alert conditions have three parts: - triggers: specify what type of activity you’d like monitored or when an alert should be triggered. - filters: help control noise by triggering an alert only if the issue matches the specified criteria. - actions: specify what should happen when the trigger conditions are met and the filters match.
Return a set of points representing a normalized timestamp and the number of events seen in the period. query ranges are limited to sentry’s configured time-series resolutions.
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
.
Return a list of values associated with this key. the query
parameter can be used to to perform a “contains” match on values. when paginated can return at most 1000 values.
Retrieves discover (also known as events) data for a given organization.
Enables spike protection feature for some of the projects within the organization.
List all members on a team. the response will not include members with pending invites.
Retrieve a saved query.
Return a list of users who have viewed a replay.
Retrieve a list of saved queries that are associated with the given organization.
Return a collection of replay recording segments.
List custom symbol sources configured for a project.
Return details on an individual metric alert rule. a metric alert rule is a configuration that defines the conditions for triggering an alert. it specifies the metric type, function, time interval, and threshold values that determine when an alert should be triggered. metric alert rules are used to monitor and notify you when certain metrics, like error count, latency, or failure rate, cross a predefined threshold. these rules help you proactively identify and address issues in your project.
Return a list of deploys for a given release.
Return a list of integration platform installations for a given organization.
Retrieve a file for a given release.
Return a list of commits for a given repository.
Return a list of source map errors for a given event.
Return a list of teams that have access to this project.
Retrieve files changed in a release’s commits
This resolves a short id to the project slug and internal issue id.
Return a service hook bound to a project.
Retrieve a list of custom dashboards that are associated with the given organization.
Lists all the available integrations for an organization.
Returns a list of emails. primary email will have isprimary: true
Return a list of projects bound to a team.
List all organization members. response includes pending invites that are approved by organization owners or managers but waiting to be accepted by the invitee.
The relevant organization member must already be a part of the team. note that for organization admins, managers, and owners, they are automatically granted a minimum team role of admin
on all teams they are part of. read more about team roles.
Update various inbound data filters for a project.
Link a team from an external provider to a sentry team.
Update the visibility for a project environment.
Create a new saved query for the given organization.
Return a list of user feedback items within this project. this list does not include submissions from the user feedback widget. this is because it is based on an older format called user reports - read more here. to return a list of user feedback items from the widget, please use the issue api with the filter issue.category:feedback
.*
Update a user in an external provider that is currently linked to a sentry user.
Update a team in an external provider that is currently linked to a sentry team.
Query an individual organization member with a scim user get request. - the name
object will contain fields firstname
and lastname
with the values of n/a
. sentry’s scim api does not currently support these fields but returns them for compatibility purposes.
Return a list of releases for a given organization.
List a project release’s commits.
Return a list of replays belonging to an organization.
Return details on an individual team.
Creates a new notification action for spike protection. notification actions notify a set of members when an action has been triggered through a notification service such as slack or sentry. for example, organization owners and managers can receive an email when a spike occurs.
this endpoint is deprecated. we document it here for older sdks and users who are still migrating to the user feedback widget or api(multi-platform). if you are a new user, do not use this endpoint - unless you don’t have a js frontend, and your platform’s sdk does not offer a feedback api. feedback must be received by the server no more than 30 minutes after the event was saved. additionally, within 5 minutes of submitting feedback it may also be overwritten. this is useful in situations where you may need to retry sending a request due to network failures. if feedback is rejected due to a mutability threshold, a 409 status code will be returned. note: feedback may be submitted with dsn authentication (see auth documentation).
Retrieve an organization member’s details. response will be a pending invite if it has been approved by organization owners or managers but is waiting to be accepted by the invitee.
Updates an individual issue’s attributes. only the attributes submitted are modified.
Update various attributes and configurable settings for the given project. note that solely having the project:read
scope restricts updatable settings to isbookmarked
.
Update a member’s organization-level and team-level roles. note that for changing organization-roles, this endpoint is restricted to user auth tokens. additionally, both the original and desired organization role must have the same or lower permissions than the role of the organization user making the request for example, an organization manager may change someone’s role from member to manager, but not to owner.
Updates a spike protection notification action. notification actions notify a set of members when an action has been triggered through a notification service such as slack or sentry. for example, organization owners and managers can receive an email when a spike occurs.
Retrieve a list of debug information files for a given project.
Return a list of version control repositories for a given organization.
Update a monitor.
Updates a metric alert rule. see metric alert rule types under create a metric alert rule for an organization to see valid request body configurations for different types of metric alert rule types. > warning: calling this endpoint fully overwrites the specified metric alert. a metric alert rule is a configuration that defines the conditions for triggering an alert. it specifies the metric type, function, time interval, and threshold values that determine when an alert should be triggered. metric alert rules are used to monitor and notify you when certain metrics, like error count, latency, or failure rate, cross a predefined threshold. these rules help you proactively identify and address issues in your project.
Update various settings for a client key.
Update a team’s attributes with a scim group patch request.
Return a list of files for a given release.
Query summarized event counts by project for your organization. also see https://docs.sentry.io/api/organizations/retrieve-event-counts-for-an-organization-v2/ for reference.
Bulk mutate various attributes on issues. the list of issues to modify is given through the id
query parameter. it is repeated for each issue that should be modified. - for non-status updates, the id
query parameter is required. - for status updates, the id
query parameter may be omitted for a batch “update all” query. - an optional status
query parameter may be used to restrict mutations to only events with the given status. the following attributes can be modified and are supplied as json object in the body: if any ids are out of scope this operation will succeed without any data mutation.
Edit an organization’s custom dashboard as well as any bulk edits on widgets that may have been made. (for example, widgets that have been rearranged, updated queries and fields, specific display types, and so on.)
Get integration provider information about all available integrations for an organization.
This resolves an event id to the project slug and internal issue id and internal event id.
Update an organization release file.
Lists monitors, including nested monitor environments. may be filtered to a project or environment.
Returns a paginated list of teams bound to a organization with a scim groups get request. note that the members field will only contain up to 10,000 members.
Lists a project’s environments.
Query event counts for your organization. select a field, define a date range, and group or filter by columns.
Return a list of projects bound to a organization.
Update various attributes and configurable settings for the given organization.
Update a service hook.
Updates an issue alert rule. > warning: calling this endpoint fully overwrites the specified issue alert. an issue alert rule triggers whenever a new event is received for any issue in a project that matches the specified alert conditions. these conditions can include a resolved issue re-appearing or an issue affecting many users. alert conditions have three parts: - triggers - specify what type of activity you’d like monitored or when an alert should be triggered. - filters - help control noise by triggering an alert only if the issue matches the specified criteria. - actions - specify what should happen when the trigger conditions are met and the filters match.
Update a project release file.
Modify a saved query.
Upload a new file for the given release. unlike other api requests, files must be uploaded using the traditional multipart/form-data content-type. requests to this endpoint should use the region-specific domain eg. us.sentry.io
or de.sentry.io
the optional ‘name’ attribute should reflect the absolute path that this file will be referenced as. for example, in the case of javascript you might specify the full web uri.
Updates ownership configurations for a project. note that only the attributes submitted are modified.
Update a release. this can change some metadata associated with the release (the ref, url, and dates).
Update a monitor.
Update various attributes and configurable settings for the given team.
Update a primary email address
Upload a new file for the given release. unlike other api requests, files must be uploaded using the traditional multipart/form-data content-type. requests to this endpoint should use the region-specific domain eg. us.sentry.io
or de.sentry.io
. the optional ‘name’ attribute should reflect the absolute path that this file will be referenced as. for example, in the case of javascript you might specify the full web uri.
Upload a new debug information file for the given release. unlike other api requests, files must be uploaded using the traditional multipart/form-data content-type. requests to this endpoint should use the region-specific domain eg. us.sentry.io
or de.sentry.io
. the file uploaded is a zip archive of an apple .dsym folder which contains the individual debug images. uploading through this endpoint will create different files for the contained images.
Update a custom symbol source in a project.
Returns all spike protection notification actions for an organization. notification actions notify a set of members when an action has been triggered through a notification service such as slack or sentry. for example, organization owners and managers can receive an email when a spike occurs. you can use either the project
or projectslug
query parameter to filter for certain projects. note that if both are present, projectslug
takes priority.