v1

latestOpenAPI 3.0.22026-07-144652931.4 MB
Analytics

Get responder data aggregated by team

Provides incident metrics aggregated by responder.

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

<!-- theme: info -->

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

Scoped OAuth requires: analytics.write

post/analytics/metrics/responders/teams

Headers

Acceptstring required

The Accept header is used as a versioning header.

Content-Type'application/json' required

Request body

time_zonestring

The time zone to use for the results and grouping.

order'asc' | 'desc'

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

order_bystring

The column that was used for ordering the results.

Example request

{
  "filters": {
    "date_range_start": "2023-10-01T00:00:00+05:00",
    "date_range_end": "2023-10-01T00:00:00Z",
    "urgency": "high",
    "team_ids": [
      "P373JQQ",
      "PAECHJV",
      "P7SYGW6"
    ],
    "responder_ids": [
      "PDJXDF3",
      "PG4EHNS"
    ],
    "priority_ids": [
      "PC8O0L3",
      "PX01HJD",
      "P5FK83M"
    ],
    "priority_names": [
      "P1",
      "P2",
      "P3"
    ]
  },
  "time_zone": "Etc/UTC",
  "order_by": "user_id"
}

Response

Only returns data for responders and teams that match the filters and have data.

time_zonestring

The time zone to use for the results and grouping.

order'asc' | 'desc'

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

order_bystring

The column that was used for ordering the results.

Example response

{
  "filters": {
    "date_range_start": "2023-10-01T00:00:00+05:00",
    "date_range_end": "2023-10-01T00:00:00Z",
    "urgency": "high",
    "team_ids": [
      "P373JQQ",
      "PAECHJV",
      "P7SYGW6"
    ],
    "responder_ids": [
      "PDJXDF3",
      "PG4EHNS"
    ],
    "priority_ids": [
      "PC8O0L3",
      "PX01HJD",
      "P5FK83M"
    ],
    "priority_names": [
      "P1",
      "P2",
      "P3"
    ]
  },
  "time_zone": "Etc/UTC",
  "order_by": "user_id"
}