List an Organization's Open Periods

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

Return a list of open periods, newest first, for either a detector or a group. Pass exactly one of detectorId or groupId.

Path Parameters

organization_id_or_slug (string)
REQUIRED

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

Query Parameters:

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.

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.

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.

per_page (integer)

Limit the number of rows to return in the result. Default and maximum allowed is 100.

cursor (string)

A pointer to the last object fetched and its sort order; used to retrieve the next or previous results.

detectorId (string)

ID of the detector. Returns open periods from every issue the detector has opened if it opens a new issue per activation, otherwise from its most recent issue.

groupId (string)

ID of the issue group.

eventId (string)

ID of the event to filter open periods by.

bucketSize (integer)

Seconds to subtract from each open period's start and end, such as the detector's time window, so they line up with the event bucket instead of the update. Defaults to 0.

Scopes

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