Query Dropped Events

ExperimentalThis API is under active development and may change.
GET /api/0/organizations/{organization_id_or_slug}/events-dropped/

Return the events Sentry received but dropped (rate limited, filtered, invalid, abuse, client discarded, cardinality limited) bucketed over the requested interval, alongside the accepted volume per bucket so a caller can compute the dropped share.

Select the dropped-data type with dataset and the bucket size with interval. Optionally scope the dropped side to one classification with outcome (top-level) and/or reason (sub-classification within an outcome); the accepted volume is always returned in full.

Path Parameters

organization_id_or_slug (string)
REQUIRED

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

Query Parameters:

dataset (string)
REQUIRED
choices:
  • errors
  • logs
  • profile_functions
  • spans
  • tracemetrics
  • uptime_results

Which dataset to query. The chosen dataset determines which fields are queryable.

  • errors - Error events.
  • logs - Structured log events.
  • profile_functions - Function-level Profiling data.
  • spans - Distributed tracing span events.
  • tracemetrics - Application Metrics.
  • uptime_results - Uptime monitoring check results.
end (string)

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

environment (array(string))

The name of environments to filter by.

project (array(undefined))

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
start (string)

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

statsPeriod (string)

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.

interval (integer)

The size of the bucket for the timeseries to have, must be a value smaller than the window being queried. If the interval is invalid a default interval will be selected instead

outcome (string)
choices:
  • filtered
  • rate_limited
  • invalid
  • abuse
  • client_discard
  • cardinality_limited

Narrow the dropped events (only) to a single top-level drop classification (e.g. rate_limited, filtered).

  • filtered
  • rate_limited
  • invalid
  • abuse
  • client_discard
  • cardinality_limited
reason (string)

Narrow the dropped events to a single reason, the sub-classification within an outcome (e.g. spike_protection within rate_limited). Should be combined with outcome.

Scopes

<auth_token> requires one of the following scopes:
  • org:admin
  • org:read
  • org:write
Copied
curl https://sentry.io/api/0/organizations/{organization_id_or_slug}/events-dropped/ \
 -H 'Authorization: Bearer <auth_token>'
RESPONSESCHEMA
Copied
.
Was this helpful?