Incident.io IncidentParticipantWorkloads V2 API

openapi: 3.2.0
info:
  description: 'This is the API reference for incident.io. It documents available API endpoints, provides examples of how to use it, and

    instructions around things like authentication and error handling. The API is hosted at:


    - https://api.incident.io/


    And you will need to create an API key via your incident.io

    dashboard to make requests. # Making requests


    Here are the key concepts required to make requests to the incident.io API. ## Authentication


    For all requests made to the incident.io API, you''ll need an API key. To create an API key, head to the incident dashboard and visit API

    keys. When you create the key, you''ll be able to choose what actions it

    can take for your account: choose carefully, as those roles can only be set

    when you first create the key. We''ll only show you the token once, so make sure

    you store it somewhere safe. API keys are global to your incident.io account, and can be managed by anyone

    who has the right permissions. We display the user that created the API key,

    and the API key will remain valid if that user becomes deactivated. Once you have the key, you should make requests to the API that set the

    `Authorization` request header using a "Bearer" authentication scheme:


    ```

    Authorization: Bearer

    ```


    ## Rate Limits


    The incident.io API enforces rate limits to ensure consistent performance for all users. The default rate limit is 1200 requests/minute per API key. This limit applies to most endpoints across the API. Limits are token buckets that refill continuously rather than resetting on a fixed window boundary. The default

    bucket holds 1200 requests and refills at 20 per second, so you can burst up to the full bucket and then sustain

    20 requests/second indefinitely. There is no boundary at which your quota resets to full in one step. Some endpoints have lower rate limits, particularly those that interact with external third-party systems that impose

    their own limitations. These specific limits vary by endpoint. ### Rate limit headers


    Responses to requests authenticated with an API key carry your current allowance, so you can pace yourself rather

    than waiting to be throttled:


    ```

    X-RateLimit-Limit: 60, 1200;window=60, 60;window=60

    X-RateLimit-Remaining: 59

    X-RateLimit-Used: 1

    X-RateLimit-Reset: 1785173199

    ```


    | Header | Meaning |

    | --- | --- |

    | `X-RateLimit-Limit` | The quota that binds this request, followed by every limit that applied and the window it applies over |

    | `X-RateLimit-Remaining` | Requests you can make right now against the binding limit |

    | `X-RateLimit-Used` | Requests you have spent against it |

    | `X-RateLimit-Reset` | Unix timestamp (seconds) at which that limit will be back to full |


    More than one limit can apply to a request: your API key''s overall limit, and for some endpoints a lower limit of

    their own. `X-RateLimit-Limit` lists all of them, each with its window, so `1200;window=60` means 1200 requests per

    minute. Because our limits refill continuously rather than resetting on a boundary, that window is what tells you

    the rate you can sustain: 1200 per 60 seconds is 20 requests/second indefinitely. `Remaining`, `Used` and `Reset` describe whichever limit has the least allowance left, since that is the one you

    will hit first. `X-RateLimit-Remaining` may lag by a small number of requests under high concurrency, and can move by more than the

    requests you made, because limits scoped to your whole organisation are shared with your other API keys. Headers are omitted rather than guessed if we cannot determine your allowance for a request. ### Exceeding a rate limit


    When you exceed a rate limit the API responds with `429 Too Many Requests` and a `Retry-After` header giving the

    number of seconds to wait:


    ```

    X-RateLimit-Limit: 1200, 1200;window=60

    X-RateLimit-Remaining: 0

    X-RateLimit-Used: 1200

    X-RateLimit-Reset: 1785173199

    Retry-After: 1

    ```


    Prefer `Retry-After` over `X-RateLimit-Reset` when deciding how long to back off.'
  title: incident.io IncidentParticipantWorkloads V2 API
  version: 1.0.0
servers:
- url: https://api.incident.io
security:
- BearerAuth: []
tags:
- description: Read how much time each participant has spent working on an incident.
  name: IncidentParticipantWorkloads V2
paths:
  /v2/incident_participant_workloads:
    get:
      description: '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 for private incidents is only returned to API keys with the

        `incident_workloads.view_private` scope.'
      operationId: IncidentParticipantWorkloadsV2#List
      parameters:
      - allowEmptyValue: true
        description: Find participant workload for this incident
        example: 01FCNDV6P870EA6S7TK1DSYD5H
        in: query
        name: incident_id
        required: true
        schema:
          description: Find participant workload for this incident
          example: 01FCNDV6P870EA6S7TK1DSYD5H
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                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'
              schema:
                $ref: '#/components/schemas/IncidentParticipantWorkloadsListResultV2'
          description: OK response.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn''t exist.'
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'authentication_error: Authentication failed.'
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'resource_forbidden: Access to this resource is forbidden for the authenticated user.'
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'not_found: The referenced resource could not be found.'
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'method_not_allowed: The endpoint does not support this operation for the specified resource.'
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'not_acceptable: Requested a media type this endpoint does not support.'
        '408':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'request_timeout: The request took too long to process.


            client_timeout: The request was cancelled by the client.'
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'conflict: Request conflicted with current state of the resource, likely a concurrent update.'
        '412':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'precondition_failed: A required condition hasn''t been met.'
        '413':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'payload_too_large: The request payload is too large.'
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'validation_error: A required field was not provided, or the provided data was invalid.'
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.


            rate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later.'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: 'api_error: Something went wrong and has been reported internally.'
      summary: List IncidentParticipantWorkloads V2
      tags:
      - IncidentParticipantWorkloads V2
      x-docs-display-name: List
      x-docs-group-name: Incident Participant Workloads V2
      x-docs-resource-type: IncidentParticipantWorkloadV2
      x-mint:
        content: 🔑 Requires the `incident_workloads.view` scope.
      x-rbac-scopes:
      - incident_workloads.view
      x-operation-id-source: normalized
      x-operation-id-original: IncidentParticipantWorkloads V2#List
components:
  schemas:
    ErrorRateLimit:
      example:
        limit: 100
        name: client_ip
        remaining: 98
        retry_after: '2020-01-01T00:00:00Z'
      properties:
        limit:
          description: The maximum number of requests that the consumer is permitted to make per minute
          example: 100
          format: int64
          type: integer
        name:
          description: Which rate limit was exceeded
          example: client_ip
          type: string
        remaining:
          description: The number of requests remaining in the current rate limit window
          example: 98
          format: int64
          type: integer
        retry_after:
          description: When the client can retry, as an RFC3339 timestamp in UTC. Prefer the Retry-After response header, which carries the same instant as a number of seconds
          example: '2020-01-01T00:00:00Z'
          type: string
      required:
      - name
      - limit
      - remaining
      - retry_after
      type: object
    ErrorResponse:
      example:
        debug:
          message: 'Something broke: and something else: and something else'
          stacktrace:
          - thing.go:123
        errors:
        - code: trial_expired
          message: Default incident call link must be a valid URL
          metadata:
            abc123: abc123
          source:
            field: default_call_url
            pointer: /settings/default_call_url
        rate_limit:
          limit: 100
          name: client_ip
          remaining: 98
          retry_after: '2020-01-01T00:00:00Z'
        request_id: 2T1p0e3j
        status: 408
        type: invalid_request_error
      properties:
        debug:
          $ref: '#/components/schemas/ErrorDebug'
        errors:
          description: List of errors that caused this request to fail
          example:
          - code: trial_expired
            message: Default incident call link must be a valid URL
            metadata:
              abc123: abc123
            source:
              field: default_call_url
              pointer: /settings/default_call_url
          items:
            $ref: '#/components/schemas/ErrorSingle'
          type: array
        rate_limit:
          $ref: '#/components/schemas/ErrorRateLimit'
        request_id:
          description: Unique identifier of the request
          example: 2T1p0e3j
          type: string
        status:
          description: HTTP status of the response
          example: 408
          format: int64
          type: integer
        type:
          description: Machine-readable identifier for the general category of error
          enum:
          - invalid_request_error
          - authentication_error
          - resource_forbidden
          - not_found
          - not_acceptable
          - method_not_allowed
          - request_timeout
          - conflict
          - precondition_failed
          - payload_too_large
          - validation_error
          - too_many_requests
          - api_error
          - rate_limit_reached
          - client_timeout
          example: invalid_request_error
          type: string
      required:
      - type
      - status
      - request_id
      - errors
      type: object
    WorkloadMetadataV2:
      example:
        data_synced_at: '2021-08-17T13:00:00Z'
      properties:
        data_synced_at:
          description: The time the workload figures are calculated up to. Workload is complete up to this time. Null if we have not calculated any workload for this incident yet.
          example: '2021-08-17T13:00:00Z'
          format: date-time
          type: string
      type: object
    ErrorDebug:
      example:
        message: 'Something broke: and something else: and something else'
        stacktrace:
        - thing.go:123
      properties:
        message:
          description: Original internal error message
          example: 'Something broke: and something else: and something else'
          type: string
        stacktrace:
          description: Stacktrace of the error, if applicable
          example:
          - thing.go:123
          items:
            example: thing.go:123
            type: string
          type: array
      required:
      - message
      - stacktrace
      type: object
    IncidentParticipantWorkloadsListResultV2:
      example:
        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'
      properties:
        incident_participant_workloads:
          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
          items:
            $ref: '#/components/schemas/IncidentParticipantWorkloadV2'
          type: array
        metadata:
          $ref: '#/components/schemas/WorkloadMetadataV2'
      required:
      - incident_participant_workloads
      - metadata
      type: object
    WorkloadMinutesV2:
      example:
        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
      properties:
        minutes_spent_on_incident:
          description: Total minutes the user spent on the incident
          example: 125.5
          format: double
          type: number
        minutes_spent_on_incident_in_late_hours:
          description: Minutes spent during the user's late hours
          example: 20.5
          format: double
          type: number
        minutes_spent_on_incident_in_sleeping_hours:
          description: Minutes spent during the user's sleeping hours
          example: 15
          format: double
          type: number
        minutes_spent_on_incident_in_working_hours:
          description: Minutes spent during the user's working hours
          example: 90
          format: double
          type: number
      required:
      - minutes_spent_on_incident
      - minutes_spent_on_incident_in_working_hours
      - minutes_spent_on_incident_in_late_hours
      - minutes_spent_on_incident_in_sleeping_hours
      type: object
    UserV2:
      example:
        email: lisa@incident.io
        id: 01FCNDV6P870EA6S7TK1DSYDG0
        name: Lisa Karlin Curtis
        role: owner
        slack_user_id: U02AYNF2XJM
      properties:
        email:
          description: Email address of the user.
          example: lisa@incident.io
          type: string
        id:
          description: Unique identifier of the user
          example: 01FCNDV6P870EA6S7TK1DSYDG0
          type: string
        name:
          description: Name of the user
          example: Lisa Karlin Curtis
          type: string
        role:
          description: 'DEPRECATED: Role of the user as of March 9th 2023, this value is no longer updated.'
          enum:
          - viewer
          - responder
          - administrator
          - owner
          - unset
          example: owner
          type: string
        slack_user_id:
          description: Slack ID of the user
          example: U02AYNF2XJM
          type: string
      required:
      - role
      - id
      - name
      type: object
    ErrorSource:
      example:
        field: default_call_url
        pointer: /settings/default_call_url
      properties:
        field:
          description: Field name that is the source of the error
          example: default_call_url
          type: string
        pointer:
          description: JSON pointer to the request field that is the source of the error
          example: /settings/default_call_url
          type: string
      required:
      - field
      - pointer
      type: object
    IncidentParticipantWorkloadV2:
      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
      properties:
        archived_at:
          description: When the user left the incident, if they are no longer an active participant
          example: '2021-08-17T13:28:57.801578Z'
          format: date-time
          type: string
        participant_type:
          description: The role they had in the incident
          enum:
          - observer
          - collaborator
          - responder
          example: observer
          type: string
        user:
          $ref: '#/components/schemas/UserV2'
        workload:
          $ref: '#/components/schemas/WorkloadMinutesV2'
      required:
      - user
      - workload
      type: object
    ErrorSingle:
      example:
        code: trial_expired
        message: Default incident call link must be a valid URL
        metadata:
          abc123: abc123
        source:
          field: default_call_url
          pointer: /settings/default_call_url
      properties:
        code:
          description: Machine-readable identifier for this specific error
          example: trial_expired
          type: string
        message:
          description: Human readable description of the error
          example: Default incident call link must be a valid URL
          type: string
        metadata:
          additionalProperties:
            example: abc123
            type: string
          description: Additional metadata about the error, keyed by a string identifier
          example:
            abc123: abc123
          type: object
        source:
          $ref: '#/components/schemas/ErrorSource'
      required:
      - code
      - message
      type: object
  securitySchemes:
    BearerAuth:
      description: API key from your incident.io dashboard (Settings > API keys)
      scheme: bearer
      type: http
externalDocs:
  description: View our API docs at api-docs.incident.io
  url: https://api-docs.incident.io/
x-provenance:
  method: harvested
  publisher: Incident.io
  source: https://api.incident.io/v1/openapiV3.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)