> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flashcat.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Get responder insight

> Return insight metrics aggregated by responder.

## Restrictions

| Aspect      | Value                                                         |
| ----------- | ------------------------------------------------------------- |
| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |
| Permissions | **Analytics Read** (`on-call`)                                |


## OpenAPI

````yaml /api-reference/on-call.openapi.en.json post /insight/responder
openapi: 3.1.0
info:
  title: Flashduty Open API
  description: >-
    Public HTTP API for the Flashduty incident management platform — incidents,
    notification templates, channels, schedules, monitors, RUM, and platform
    administration. Every operation is authenticated with an `app_key` query
    parameter issued from the Flashduty console under Account → APP Keys.
    Responses follow a uniform envelope: `{ request_id, data }` on success, `{
    request_id, error }` on failure.
  version: 1.0.0
servers:
  - url: https://api.flashcat.cloud
    description: Flashduty Open API
security:
  - AppKeyAuth: []
tags:
  - name: On-call/Incidents
    description: ''
  - name: On-call/Channels
    description: ''
  - name: On-call/Alerts
    description: >-
      Search, inspect, and act on alerts. Manage card views and alert processing
      pipelines.
  - name: On-call/Integrations
    description: ''
  - name: On-call/IM integrations
    description: IM integration queries, such as which integrations have war room enabled.
  - name: On-call/Schedules
    description: ''
  - name: On-call/Calendars
    description: ''
  - name: On-call/Notification templates
    description: ''
  - name: On-call/Alert enrichment
    description: Custom fields, enrichment rules, and data mapping (schema, data, API).
  - name: On-call/Analytics
    description: ''
  - name: On-call/Status pages
    description: ''
  - name: On-call/Changes
    description: ''
paths:
  /insight/responder:
    post:
      tags:
        - On-call/Analytics
      summary: Get responder insight
      description: Return insight metrics aggregated by responder.
      operationId: insightByResponder
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InsightQueryRequest'
            example:
              start_time: 1712000000
              end_time: 1712604800
              responder_ids:
                - 3790925372131
              aggregate_unit: day
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/SuccessEnvelope'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/ResponderInsightResponse'
              example:
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
                data:
                  items:
                    - ts: 1740844800
                      responder_id: 3790925372131
                      responder_name: alice
                      total_incident_cnt: 1
                      total_incidents_acknowledged: 1
                      total_incidents_reassigned: 0
                      total_incidents_escalated: 0
                      total_incidents_timeout_escalated: 0
                      total_incidents_manually_escalated: 0
                      total_interruptions: 1
                      total_notifications: 2
                      total_engaged_seconds: 10
                      total_seconds_to_ack: 2265624
                      mean_seconds_to_ack: 2265624
                      acknowledgement_pct: 100
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  schemas:
    InsightQueryRequest:
      allOf:
        - $ref: '#/components/schemas/InsightFilter'
        - type: object
          description: >-
            Insight dimension-aggregation request. Extends InsightFilter with
            aggregation controls.
          properties:
            split_hours:
              type: boolean
              description: >-
                When true, metrics are split into `work`/`sleep`/`off` hour
                buckets.
            aggregate_unit:
              type: string
              enum:
                - day
                - week
                - month
              description: >-
                Aggregate metrics into time buckets. When set, the time range
                must cover at least 24 hours; `day` additionally caps the range
                at 31 days.
    SuccessEnvelope:
      type: object
      description: >-
        Success response envelope. On every 2xx response, `request_id`
        identifies the call (also mirrored in the `Flashcat-Request-Id` header)
        and `data` holds the endpoint-specific payload. Failure responses use a
        different shape — see `ErrorResponse`.
      properties:
        request_id:
          type: string
          description: >-
            Unique ID for this request. Mirrored in the Flashcat-Request-Id
            response header. Include it when reporting issues.
          example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
        data:
          description: Endpoint-specific payload. See each operation's 200 response schema.
      required:
        - request_id
        - data
    ResponderInsightResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ResponderInsightItem'
    InsightFilter:
      type: object
      description: >-
        Shared filter envelope for insight and export endpoints. Severities
        accept up to 3 values; team/channel/responder/incident filters accept up
        to 100 IDs each. The time range cannot exceed one year.
      required:
        - start_time
        - end_time
      properties:
        start_time:
          type: integer
          format: int64
          description: Start time, Unix seconds. Must be greater than 0.
        end_time:
          type: integer
          format: int64
          description: End time, Unix seconds. Must be greater than `start_time`.
        team_ids:
          type: array
          items:
            type: integer
            format: int64
          description: Filter by team IDs. At most 100 entries.
        channel_ids:
          type: array
          items:
            type: integer
            format: int64
          description: Filter by channel IDs. At most 100 entries.
        responder_ids:
          type: array
          items:
            type: integer
            format: int64
          description: Filter by responder person IDs. At most 100 entries.
        severities:
          type: array
          items:
            type: string
            enum:
              - Critical
              - Warning
              - Info
              - Ok
          description: Filter by severity. At most 3 entries.
        incident_ids:
          type: array
          items:
            type: string
            pattern: ^[0-9a-fA-F]{24}$
          description: Filter by incident IDs (MongoDB ObjectIDs). At most 100 entries.
        query:
          type: string
          description: Full-text query applied to incident title and description.
        labels:
          type: object
          additionalProperties:
            type: string
          description: Label filters (exact match).
        fields:
          type: object
          additionalProperties: true
          description: Custom-field filters (exact match).
        orderby:
          type: string
          enum:
            - created_at
          description: Field to sort the underlying incident set by.
        asc:
          type: boolean
          description: Sort ascending when `true`, descending otherwise.
        is_my_team:
          type: boolean
          description: >-
            Restrict results to teams the caller belongs to. When true and the
            caller has no teams, the result set is empty.
        time_zone:
          type: string
          description: >-
            IANA time zone name used to interpret the time range (e.g.
            `Asia/Shanghai`). Defaults to the account time zone.
        seconds_to_close_from:
          type: integer
          format: int64
          description: Lower bound (inclusive) on time-to-close, in seconds.
        seconds_to_close_to:
          type: integer
          format: int64
          description: >-
            Upper bound (exclusive) on time-to-close, in seconds. Must be
            greater than `seconds_to_close_from` when both are set.
        seconds_to_ack_from:
          type: integer
          format: int64
          description: Lower bound (inclusive) on time-to-acknowledge, in seconds.
        seconds_to_ack_to:
          type: integer
          format: int64
          description: >-
            Upper bound (exclusive) on time-to-acknowledge, in seconds. Must be
            greater than `seconds_to_ack_from` when both are set.
        export_fields:
          type: array
          items:
            type: string
            enum:
              - incident_id
              - title
              - severity
              - progress
              - channel_id
              - channel_name
              - team_id
              - team_name
              - created_at
              - seconds_to_ack
              - seconds_to_close
              - closed_by
              - engaged_seconds
              - hours
              - notifications
              - interruptions
              - acknowledgements
              - assignments
              - reassignments
              - escalations
              - manual_escalations
              - timeout_escalations
              - assigned_to
              - responders
              - description
              - labels
              - fields
              - creator_id
              - creator_name
          description: >-
            Subset of CSV column keys to include in the export. At most 50
            entries. Only used by the export endpoints.
        description_html_to_text:
          type: boolean
          description: Strip HTML markup from the description column when exporting.
    ResponderInsightItem:
      allOf:
        - $ref: '#/components/schemas/MetricsBase'
        - type: object
          description: Aggregated incident metrics for a single responder.
          properties:
            total_incident_cnt:
              type: integer
              format: int64
            total_incidents_acknowledged:
              type: integer
              format: int64
            total_incidents_reassigned:
              type: integer
              format: int64
            total_incidents_escalated:
              type: integer
              format: int64
            total_incidents_timeout_escalated:
              type: integer
              format: int64
            total_incidents_manually_escalated:
              type: integer
              format: int64
            total_interruptions:
              type: integer
              format: int64
            total_notifications:
              type: integer
              format: int64
            total_engaged_seconds:
              type: integer
              format: int64
            total_seconds_to_ack:
              type: integer
              format: int64
            mean_seconds_to_ack:
              type: number
              format: double
            acknowledgement_pct:
              type: number
              format: double
    ErrorResponse:
      type: object
      description: Response envelope for errors. `error` is required; `data` is absent.
      properties:
        request_id:
          type: string
          example: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
        error:
          $ref: '#/components/schemas/DutyError'
      required:
        - request_id
        - error
    MetricsBase:
      type: object
      description: Shared dimension identifiers attached to every aggregated insight row.
      properties:
        hours:
          type: string
          enum:
            - work
            - sleep
            - 'off'
          description: Hour bucket when `split_hours` is enabled.
        ts:
          type: integer
          format: int64
          description: >-
            Aggregation bucket start time, Unix seconds. Present when
            `aggregate_unit` is used.
        channel_id:
          type: integer
          format: int64
        team_id:
          type: integer
          format: int64
        responder_id:
          type: integer
          format: int64
        account_id:
          type: integer
          format: int64
        team_name:
          type: string
        channel_name:
          type: string
        responder_name:
          type: string
    DutyError:
      type: object
      description: >-
        Error payload inside the response envelope. Present only on non-2xx
        responses.
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode'
        message:
          type: string
          description: >-
            Human-readable error message, localized by the caller's
            Accept-Language. May contain field names, IDs, or other context from
            the failing request.
          example: The specified parameter template_id is not valid.
      required:
        - code
        - message
    ErrorCode:
      type: string
      description: >-
        Flashduty error code enum. Every failed API response sets `error.code`
        to one of these stable wire strings. HTTP status is informational — the
        authoritative signal is the enum value.


        | Code | HTTP | Meaning |

        |---|---|---|

        | `OK` | 200 | Reserved — not returned on real errors. |

        | `InvalidParameter` | 400 | A required parameter is missing or failed
        validation. |

        | `BadRequest` | 400 | Generic 400 used when no more specific code fits.
        |

        | `InvalidContentType` | 400 | The `Content-Type` header is not
        `application/json`. |

        | `ResourceNotFound` | 400 | The referenced resource does not exist.
        Note: returned as HTTP 400, not 404 (historical choice). |

        | `NoLicense` | 400 | The feature is license-gated and no active license
        was found. |

        | `ReferenceExist` | 400 | Deletion blocked — other entities still
        reference this resource. |

        | `Unauthorized` | 401 | `app_key` is missing, invalid, or expired. |

        | `BalanceNotEnough` | 402 | Billing-gated operation with insufficient
        account balance. |

        | `AccessDenied` | 403 | Authenticated but lacking the permission
        required for this operation. |

        | `RouteNotFound` | 404 | The request URL path is not a known route. |

        | `MethodNotAllowed` | 405 | The HTTP method is not allowed on this
        otherwise-known path. |

        | `UndonedOrderExist` | 409 | An outstanding billing order blocks this
        new one. Wait and retry. |

        | `RequestLocked` | 423 | Operation temporarily locked due to repeated
        failures. |

        | `EntityTooLarge` | 413 | Request body exceeds the configured max size.
        |

        | `RequestTooFrequently` | 429 | Rate limit hit — API-global,
        per-account, or per-integration. |

        | `RequestVerifyRequired` | 428 | Second-factor verification required
        but not supplied. |

        | `DangerousOperation` | 428 | High-risk operation requires MFA
        verification. |

        | `InternalError` | 500 | Unhandled server-side error. Include
        `request_id` in the bug report. |

        | `ServiceUnavailable` | 503 | A backend dependency is unavailable. Try
        again later. |
      enum:
        - OK
        - InvalidParameter
        - BadRequest
        - InvalidContentType
        - ResourceNotFound
        - NoLicense
        - ReferenceExist
        - Unauthorized
        - BalanceNotEnough
        - AccessDenied
        - RouteNotFound
        - MethodNotAllowed
        - UndonedOrderExist
        - RequestLocked
        - EntityTooLarge
        - RequestTooFrequently
        - RequestVerifyRequired
        - DangerousOperation
        - InternalError
        - ServiceUnavailable
      x-enumDescriptions:
        OK: Reserved — not returned on real errors.
        InvalidParameter: A required parameter is missing or failed validation.
        BadRequest: Generic 400 used when no more specific code fits.
        InvalidContentType: The `Content-Type` header is not `application/json`.
        ResourceNotFound: >-
          The referenced resource does not exist. Note: returned as HTTP 400,
          not 404 (historical choice).
        NoLicense: The feature is license-gated and no active license was found.
        ReferenceExist: Deletion blocked — other entities still reference this resource.
        Unauthorized: '`app_key` is missing, invalid, or expired.'
        BalanceNotEnough: Billing-gated operation with insufficient account balance.
        AccessDenied: Authenticated but lacking the permission required for this operation.
        RouteNotFound: The request URL path is not a known route.
        MethodNotAllowed: The HTTP method is not allowed on this otherwise-known path.
        UndonedOrderExist: An outstanding billing order blocks this new one. Wait and retry.
        RequestLocked: Operation temporarily locked due to repeated failures.
        EntityTooLarge: Request body exceeds the configured max size.
        RequestTooFrequently: Rate limit hit — API-global, per-account, or per-integration.
        RequestVerifyRequired: Second-factor verification required but not supplied.
        DangerousOperation: High-risk operation requires MFA verification.
        InternalError: Unhandled server-side error. Include `request_id` in the bug report.
        ServiceUnavailable: A backend dependency is unavailable. Try again later.
      example: InvalidParameter
  responses:
    BadRequest:
      description: Invalid request — usually a missing or malformed parameter.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missingParameter:
              value:
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
                error:
                  code: InvalidParameter
                  message: The specified parameter is not valid.
    Unauthorized:
      description: Missing or invalid app_key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missingAppKey:
              value:
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
                error:
                  code: Unauthorized
                  message: You are unauthorized.
    TooManyRequests:
      description: >-
        Rate limit hit. Either the global API limit, a per-account limit, or a
        per-integration limit.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            rateLimited:
              value:
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
                error:
                  code: RequestTooFrequently
                  message: Request too frequently.
    ServerError:
      description: Unexpected server-side error. Include the request_id when reporting.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            internal:
              value:
                request_id: 01HK8XQE3Z7JM2NTFQ5YJ8P9R4
                error:
                  code: InternalError
                  message: >-
                    We encountered an internal error, and it has been reported.
                    Please try again later.
  securitySchemes:
    AppKeyAuth:
      type: apiKey
      in: query
      name: app_key
      description: >-
        App key issued from the Flashduty console under Account → APP Keys.
        Required on every public API call. Keep it secret — it grants the same
        access as the owning account.

````