List

Early preview. This endpoint is in early access and its behaviour may change. Contact us to enable it for your account.

List the participants of an incident with their workload.

We calculate how much time each participant has spent working on the incident, aggregated per participant. Each participant is annotated with their participant type and, if they have left the incident, when they were archived.

Workload is calculated periodically, so values can lag real time and the most recent period may still be filling. The metadata reports the time the figures are calculated up to. Workload is not available for private incidents.

GET

incident_participant_workloads

List

curl --request GET \
  --url https://api.incident.io/v2/incident_participant_workloads \
  --header 'Authorization: Bearer <token>'

{
  "incident_participant_workloads": [
    {
      "archived_at": "2021-08-17T13:28:57.801578Z",
      "participant_type": "observer",
      "user": {
        "email": "lisa@incident.io",
        "id": "01FCNDV6P870EA6S7TK1DSYDG0",
        "name": "Lisa Karlin Curtis",
        "role": "owner",
        "slack_user_id": "U02AYNF2XJM"
      },
      "workload": {
        "minutes_spent_on_incident": 125.5,
        "minutes_spent_on_incident_in_late_hours": 20.5,
        "minutes_spent_on_incident_in_sleeping_hours": 15,
        "minutes_spent_on_incident_in_working_hours": 90
      }
    }
  ],
  "metadata": {
    "data_synced_at": "2021-08-17T13:00:00Z"
  }
}

Authorizations

Authorization

string

header

required

API key from your incident.io dashboard (Settings → API keys)

Query Parameters

incident_id

string

required

Find participant workload for this incident

Example:

"01FCNDV6P870EA6S7TK1DSYD5H"

Response

200 - application/json

OK response.

incident_participant_workloads

object[]

required

Show child attributes

Example:

[
  {
    "archived_at": "2021-08-17T13:28:57.801578Z",
    "participant_type": "observer",
    "user": {
      "email": "lisa@incident.io",
      "id": "01FCNDV6P870EA6S7TK1DSYDG0",
      "name": "Lisa Karlin Curtis",
      "role": "owner",
      "slack_user_id": "U02AYNF2XJM"
    },
    "workload": {
      "minutes_spent_on_incident": 125.5,
      "minutes_spent_on_incident_in_late_hours": 20.5,
      "minutes_spent_on_incident_in_sleeping_hours": 15,
      "minutes_spent_on_incident_in_working_hours": 90
    }
  }
]

metadata

object

required

Show child attributes

Example:

{ "data_synced_at": "2021-08-17T13:00:00Z" }

Incident Participant Workloads

Incident Relationships

⌘I

List

curl --request GET \
  --url https://api.incident.io/v2/incident_participant_workloads \
  --header 'Authorization: Bearer <token>'

{
  "incident_participant_workloads": [
    {
      "archived_at": "2021-08-17T13:28:57.801578Z",
      "participant_type": "observer",
      "user": {
        "email": "lisa@incident.io",
        "id": "01FCNDV6P870EA6S7TK1DSYDG0",
        "name": "Lisa Karlin Curtis",
        "role": "owner",
        "slack_user_id": "U02AYNF2XJM"
      },
      "workload": {
        "minutes_spent_on_incident": 125.5,
        "minutes_spent_on_incident_in_late_hours": 20.5,
        "minutes_spent_on_incident_in_sleeping_hours": 15,
        "minutes_spent_on_incident_in_working_hours": 90
      }
    }
  ],
  "metadata": {
    "data_synced_at": "2021-08-17T13:00:00Z"
  }
}