v1

latestOpenAPI 3.0.22026-07-144652931.4 MB

Analytics

Get raw data - multiple incidents

Provides enriched incident data and metrics for multiple incidents.

Example metrics include Seconds to Resolve, Seconds to Engage, Snoozed Seconds, and Sleep Hour Interruptions. Metric definitions can be found in our Knowledge Base.

A team_ids or service_ids filter is required for user-level API keys or keys generated through an OAuth flow. Account-level API keys do not have this requirement.

Note: Data availability reflects pipeline processing cycles and is generally within 24 hours under normal conditions.

Scoped OAuth requires: analytics.write

post/analytics/raw/incidents

Headers

Acceptstring required

The Accept header is used as a versioning header.

Content-Type'application/json' required

Request body

starting_afterstring

A cursor to indicate the reference point that the results should follow

ending_beforestring

A cursor to indicate the reference point that the results should precede

order'asc' | 'desc'

The order the results; asc for ascending, desc for descending. Defaults to 'desc'.

order_by'created_at' | 'seconds_to_resolve'

The column to use for ordering the results. Defaults to 'created_at'.

limitinteger

Number of results to include in each batch. Limits between 1 to 1000 are accepted.

time_zonestring

The time zone to use for the results.

Example request

{
  "filters": {
    "created_at_start": "2023-05-01T00:00:00-04:00",
    "created_at_end": "2023-06-01T00:00:00-04:00",
    "urgency": "high",
    "major": true,
    "team_ids": [
      "P373JQQ",
      "PAECHJV",
      "P7SYGW6"
    ],
    "service_ids": [
      "PC8O0L3",
      "PX01HJD",
      "P5FK83M"
    ],
    "priority_ids": [
      "PITMC5Y",
      "PEHBBT8",
      "PB8QADI"
    ],
    "priority_names": [
      "P1",
      "P2",
      "P3"
    ],
    "incident_type_ids": [
      "PIJ90N7",
      "PKL73Z2"
    ]
  },
  "limit": 20,
  "time_zone": "Etc/UTC"
}

Response

firststring required

Cursor to identify the first object in the response.

laststring required

Cursor to identify the last object in the response.

limitinteger required

Number of results to include in the batch.

moreboolean required

Indicates if there are more resources available than were returned.

order'asc' | 'desc' required

The order in which the results were sorted; asc for ascending, desc for descending.

order_by'created_at' | 'seconds_to_resolve' | 'updated_at' required

The column that was used for ordering the results.

time_zonestring required

The time zone that the results are in.