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

# One-shot envelope of every integration analytics pipe



## OpenAPI

````yaml /api-reference/openapi.json get /v1/analytics/integrations/dashboard
openapi: 3.1.0
info:
  title: Feather API
  description: >-
    Unified customer experience platform API. Manages identity, conversations,
    memory, agents, procedures, policies, model routing, knowledge bases,
    integrations, and runtime execution.
  version: 1.21.0
servers:
  - url: https://api-sandbox.featherhq.com
    description: Sandbox
  - url: http://localhost:8000
    description: Local dev
security: []
paths:
  /v1/analytics/integrations/dashboard:
    get:
      tags:
        - analytics
      summary: One-shot envelope of every integration analytics pipe
      operationId: getIntegrationDashboard
      parameters:
        - name: granularity
          in: query
          required: false
          schema:
            type: string
            pattern: ^(minute|hour|day|week)$
            default: hour
            title: Granularity
        - name: integration_key
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Integration Key
        - name: mode
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Mode
        - name: slug
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Slug
        - name: start_date
          in: query
          required: true
          schema:
            type: string
            format: date
            title: Start Date
        - name: end_date
          in: query
          required: true
          schema:
            type: string
            format: date
            title: End Date
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/src__analytics__integrations__schemas__DashboardEnvelope
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    src__analytics__integrations__schemas__DashboardEnvelope:
      properties:
        summary:
          items:
            $ref: >-
              #/components/schemas/src__analytics__integrations__schemas__DashboardSummaryRow
          type: array
          title: Summary
        usage:
          items:
            $ref: >-
              #/components/schemas/src__analytics__integrations__schemas__InvocationsTimeseriesRow
          type: array
          title: Usage
        success_rate:
          items:
            $ref: >-
              #/components/schemas/src__analytics__integrations__schemas__SuccessRateTimeseriesRow
          type: array
          title: Success Rate
        latency:
          items:
            $ref: '#/components/schemas/LatencyTimeseriesRow'
          type: array
          title: Latency
        by_integration:
          items:
            $ref: '#/components/schemas/InvocationsByIntegrationRow'
          type: array
          title: By Integration
        by_mode:
          items:
            $ref: '#/components/schemas/InvocationsByModeRow'
          type: array
          title: By Mode
        error_breakdown:
          items:
            $ref: >-
              #/components/schemas/src__analytics__integrations__schemas__ErrorBreakdownRow
          type: array
          title: Error Breakdown
      type: object
      required:
        - summary
        - usage
        - success_rate
        - latency
        - by_integration
        - by_mode
        - error_breakdown
      title: DashboardEnvelope
      description: >-
        Combined dashboard payload — one envelope, every integration panel.


        `summary` is at most one row but the underlying pipe returns a list, so
        we

        keep it as a (possibly empty) list rather than special-casing it on the

        client.
    ErrorResponse:
      properties:
        error:
          type: string
          title: Error
        message:
          type: string
          title: Message
      type: object
      required:
        - error
        - message
      title: ErrorResponse
      description: Standard error response returned by all API error handlers.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    src__analytics__integrations__schemas__DashboardSummaryRow:
      properties:
        current_invocations:
          anyOf:
            - type: integer
            - type: 'null'
          title: Current Invocations
        previous_invocations:
          anyOf:
            - type: integer
            - type: 'null'
          title: Previous Invocations
        pct_change_invocations:
          anyOf:
            - type: number
            - type: 'null'
          title: Pct Change Invocations
        current_failures:
          anyOf:
            - type: integer
            - type: 'null'
          title: Current Failures
        previous_failures:
          anyOf:
            - type: integer
            - type: 'null'
          title: Previous Failures
        pct_change_failures:
          anyOf:
            - type: number
            - type: 'null'
          title: Pct Change Failures
        current_success_rate_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Current Success Rate Pct
        previous_success_rate_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Previous Success Rate Pct
        pct_change_success_rate_pct:
          anyOf:
            - type: number
            - type: 'null'
          title: Pct Change Success Rate Pct
        current_avg_latency_ms:
          anyOf:
            - type: number
            - type: 'null'
          title: Current Avg Latency Ms
        previous_avg_latency_ms:
          anyOf:
            - type: number
            - type: 'null'
          title: Previous Avg Latency Ms
        pct_change_avg_latency_ms:
          anyOf:
            - type: number
            - type: 'null'
          title: Pct Change Avg Latency Ms
        current_p95_latency_ms:
          anyOf:
            - type: number
            - type: 'null'
          title: Current P95 Latency Ms
        previous_p95_latency_ms:
          anyOf:
            - type: number
            - type: 'null'
          title: Previous P95 Latency Ms
        pct_change_p95_latency_ms:
          anyOf:
            - type: number
            - type: 'null'
          title: Pct Change P95 Latency Ms
      type: object
      title: DashboardSummaryRow
    src__analytics__integrations__schemas__InvocationsTimeseriesRow:
      properties:
        time_bucket:
          type: string
          format: date-time
          title: Time Bucket
        invocations:
          type: integer
          title: Invocations
        successful:
          type: integer
          title: Successful
        vendor_errors:
          type: integer
          title: Vendor Errors
        exceptions:
          type: integer
          title: Exceptions
      type: object
      required:
        - time_bucket
        - invocations
        - successful
        - vendor_errors
        - exceptions
      title: InvocationsTimeseriesRow
    src__analytics__integrations__schemas__SuccessRateTimeseriesRow:
      properties:
        time_bucket:
          type: string
          format: date-time
          title: Time Bucket
        invocations:
          type: integer
          title: Invocations
        successful:
          type: integer
          title: Successful
        success_rate_pct:
          type: number
          title: Success Rate Pct
      type: object
      required:
        - time_bucket
        - invocations
        - successful
        - success_rate_pct
      title: SuccessRateTimeseriesRow
    LatencyTimeseriesRow:
      properties:
        time_bucket:
          type: string
          format: date-time
          title: Time Bucket
        invocations:
          type: integer
          title: Invocations
        p50_ms:
          type: number
          title: P50 Ms
        p90_ms:
          type: number
          title: P90 Ms
        p95_ms:
          type: number
          title: P95 Ms
        p99_ms:
          type: number
          title: P99 Ms
        avg_ms:
          type: number
          title: Avg Ms
        max_ms:
          type: number
          title: Max Ms
      type: object
      required:
        - time_bucket
        - invocations
        - p50_ms
        - p90_ms
        - p95_ms
        - p99_ms
        - avg_ms
        - max_ms
      title: LatencyTimeseriesRow
    InvocationsByIntegrationRow:
      properties:
        integration_key:
          type: string
          title: Integration Key
        invocations:
          type: integer
          title: Invocations
        successful:
          type: integer
          title: Successful
        vendor_errors:
          type: integer
          title: Vendor Errors
        exceptions:
          type: integer
          title: Exceptions
        success_rate_pct:
          type: number
          title: Success Rate Pct
        p95_latency_ms:
          type: number
          title: P95 Latency Ms
      type: object
      required:
        - integration_key
        - invocations
        - successful
        - vendor_errors
        - exceptions
        - success_rate_pct
        - p95_latency_ms
      title: InvocationsByIntegrationRow
    InvocationsByModeRow:
      properties:
        mode:
          type: string
          title: Mode
        invocations:
          type: integer
          title: Invocations
        successful:
          type: integer
          title: Successful
        vendor_errors:
          type: integer
          title: Vendor Errors
        exceptions:
          type: integer
          title: Exceptions
        success_rate_pct:
          type: number
          title: Success Rate Pct
        p95_latency_ms:
          type: number
          title: P95 Latency Ms
      type: object
      required:
        - mode
        - invocations
        - successful
        - vendor_errors
        - exceptions
        - success_rate_pct
        - p95_latency_ms
      title: InvocationsByModeRow
    src__analytics__integrations__schemas__ErrorBreakdownRow:
      properties:
        error_category:
          type: string
          title: Error Category
        count:
          type: integer
          title: Count
        share_pct:
          type: number
          title: Share Pct
      type: object
      required:
        - error_category
        - count
        - share_pct
      title: ErrorBreakdownRow
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: x-api-key

````