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

# Get v1analyticsoverview



## OpenAPI

````yaml /api-reference/openapi.json get /v1/analytics/overview
openapi: 3.1.0
info:
  title: Aide API
  version: '1'
  description: >-
    Aide's public API. The dashboard, personal access tokens and the MCP server
    all use these endpoints.


    **Authentication.** `Authorization: Bearer oat_…` (a teammate's access
    token) or `Authorization: Bearer aide_live_…` (a workspace API key, created
    by an owner or admin under Settings > Developers). Either is bound to one
    account; every resource is scoped to it, and another account's id answers
    404.


    **API keys** act as the workspace, not as a teammate. Operations that list
    `apiKey` under security accept them; everything else (the session, `me`,
    members, teams, billing, conversations, saved views, notifications, helpdesk
    and widget settings, and API keys themselves) answers 403
    `api_key_not_allowed`. A key with only the `read` scope gets 403
    `insufficient_scope` on writes (every method but `GET`, except `POST
    /v1/knowledge/search`, which only reads). A revoked, expired or unknown key
    answers 401 `invalid_api_key`. Requests are rate limited per key.


    **Webhooks.** Each delivery is a `POST` of the event JSON with
    `Aide-Event-Id`, `Aide-Event-Type`, `Aide-Delivery-Attempt` and
    `Aide-Signature: t=<unix seconds>,v1=<hex>`. `v1` is the HMAC-SHA256 of
    `${t}.${raw body}` keyed with the endpoint secret (`whsec_…`, the whole
    string). For 24 h after a rotation a second `v1`, signed with the previous
    secret, is included; accept the request if any `v1` matches and `t` is
    within 5 minutes. Answer 2xx within 10 s; anything else is retried with
    exponential backoff (8 attempts over about 4 h). An endpoint is disabled
    after 25 failed attempts in a row with no success for 24 h. Deduplicate on
    the event id.


    **Responses.** Successful bodies are wrapped as `{ data }`. Page-numbered
    lists add `metadata`: `total` (exact up to 10,000, then 10,000 with
    `totalIsCapped: true`), `totalIsCapped`, `perPage`, `currentPage`,
    `lastPage` and `hasMore`. `page` runs from 1 to 500, and a page that starts
    past the first 10,000 rows answers 422 `page_too_deep`. `GET
    /v1/conversations` also takes a `cursor` (not with `page`): its
    `metadata.nextCursor` pages on in the same sort without counting, and a
    cursor page has null `total`, `currentPage` and `lastPage`. Message threads
    page with `before` and `meta.nextCursor`.


    **Errors.** Every error is `{ error: { type, code, message, requestId,
    fields? } }`. Validation failures are 422 with one entry per field in
    `fields`.


    **Rate limits.** Throttled routes return `X-RateLimit-Limit` and
    `X-RateLimit-Remaining`; a 429 adds `Retry-After` and `X-RateLimit-Reset`.
servers:
  - url: https://app-api.aide.app
    description: Aide API
security: []
tags:
  - name: Account
  - name: Agent
  - name: AgentEntryPoint
  - name: AgentLinks
  - name: AgentPanelEvent
  - name: AgentPanelSessions
  - name: AgentTestConversation
  - name: Analytics
  - name: ApiKey
  - name: Attachment
  - name: Auth
  - name: Billing
  - name: ChannelActivity
  - name: ChannelConfiguration
  - name: ChannelSettings
  - name: ConnectedApp
  - name: ContactSync
  - name: Conversation
  - name: ConversationAi
  - name: ConversationCustomerContext
  - name: ConversationDraft
  - name: ConversationMacro
  - name: ConversationOrder
  - name: CustomField
  - name: EmailMailbox
  - name: EmailPreferences
  - name: GoogleSessions
  - name: HelpdeskSetting
  - name: Integration
  - name: IntegrationAiAgentRule
  - name: IntegrationSidebar
  - name: Invitation
  - name: KnowledgeCollection
  - name: KnowledgeDocument
  - name: KnowledgeEntity
  - name: KnowledgeSource
  - name: Macro
  - name: Me
  - name: Member
  - name: MessageFeedback
  - name: MessageSender
  - name: Notification
  - name: NotificationChannel
  - name: OauthAuthorization
  - name: Order
  - name: OrderAction
  - name: Plan
  - name: PolicyQuestion
  - name: Product
  - name: ProductPairing
  - name: Proposal
  - name: ReplyTemplate
  - name: RoutingRule
  - name: SavedView
  - name: Scenario
  - name: ScenarioBackfill
  - name: Schedule
  - name: SenderClassification
  - name: SenderRule
  - name: ShopifyStaffLinks
  - name: SlaPolicy
  - name: Team
  - name: Topic
  - name: TopicSuggestion
  - name: WebhookEndpoint
  - name: Widgets
paths:
  /v1/analytics/overview:
    get:
      tags:
        - Analytics
      operationId: analytics.overview
      parameters:
        - name: from
          in: query
          required: false
          schema:
            type: string
            format: date
        - name: until
          in: query
          required: false
          schema:
            type: string
            format: date
        - name: timezone
          in: query
          required: false
          schema:
            type: string
            minLength: 1
            maxLength: 64
        - name: channel
          in: query
          required: false
          schema:
            enum:
              - chat
              - gmail
              - zendesk
              - front
              - gorgias
              - messenger
              - instagram
              - whatsapp
        - name: topic
          in: query
          required: false
          schema:
            type: string
            maxLength: 64
      responses:
        '200':
          description: OK
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/AnalyticsOverview'
                required:
                  - data
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/ValidationFailed'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        default:
          $ref: '#/components/responses/Error'
      security:
        - accessToken: []
        - apiKey: []
components:
  headers:
    X-RateLimit-Limit:
      description: Requests allowed in the current window.
      schema:
        type: integer
    X-RateLimit-Remaining:
      description: Requests left in the current window.
      schema:
        type: integer
    Retry-After:
      description: Seconds until the window resets.
      schema:
        type: integer
    X-RateLimit-Reset:
      description: When the window resets.
      schema:
        type: string
        format: date-time
  schemas:
    AnalyticsOverview:
      type: object
      properties:
        object:
          type: string
          const: analytics_overview
        topics:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              id:
                type: string
              deploy:
                type: string
                enum:
                  - fully_agentic
                  - human_in_loop
                  - none
              conversations:
                type: object
                properties:
                  value:
                    type: number
                  previous:
                    type: number
                required:
                  - value
                  - previous
              layers:
                type: object
                properties:
                  eligible:
                    type: number
                  confirmed:
                    type: number
                  assumed:
                    type: number
                  reopened:
                    type: number
                  decided:
                    type: number
                  previousRate:
                    type:
                      - number
                      - 'null'
                required:
                  - eligible
                  - confirmed
                  - assumed
                  - reopened
                  - decided
                  - previousRate
              handoffShare:
                type:
                  - number
                  - 'null'
              underConfidenceShare:
                type:
                  - number
                  - 'null'
              series:
                type: array
                items:
                  type: number
            required:
              - name
              - id
              - deploy
              - conversations
              - layers
              - handoffShare
              - underConfidenceShare
              - series
        until:
          type: string
        from:
          type: string
        timezone:
          type: string
        channels:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              slug:
                type: string
              conversations:
                type: object
                properties:
                  value:
                    type: number
                  previous:
                    type: number
                required:
                  - value
                  - previous
              series:
                type: array
                items:
                  type: number
              aideAnswered:
                type:
                  - number
                  - 'null'
              aideAnsweredIsProxy:
                type: boolean
              handedOff:
                type:
                  - number
                  - 'null'
              resolutionRate:
                type:
                  - number
                  - 'null'
            required:
              - name
              - slug
              - conversations
              - series
              - aideAnswered
              - aideAnsweredIsProxy
              - handedOff
              - resolutionRate
        previousFrom:
          type: string
        previousUntil:
          type: string
        asOf:
          type: string
        seasonalBaseline:
          type: boolean
        eligible:
          type: object
          properties:
            value:
              type: number
            previous:
              type: number
          required:
            - value
            - previous
        volumeByDay:
          type: array
          items:
            type: object
            properties:
              value:
                type: number
              date:
                type: string
              aiHandled:
                type: number
            required:
              - value
              - date
              - aiHandled
        resolution:
          type: object
          properties:
            eligible:
              type: number
            confirmed:
              type: number
            assumed:
              type: number
            reopened:
              type: number
            decided:
              type: number
            previousRate:
              type:
                - number
                - 'null'
          required:
            - eligible
            - confirmed
            - assumed
            - reopened
            - decided
            - previousRate
        metrics:
          type: object
          properties:
            ai_resolution_rate:
              type: object
              properties:
                'n':
                  type: number
                value:
                  type:
                    - number
                    - 'null'
                previous:
                  type:
                    - number
                    - 'null'
                series:
                  type: array
                  items:
                    type:
                      - number
                      - 'null'
              required:
                - 'n'
                - value
                - previous
                - series
            not_reopened:
              type: object
              properties:
                'n':
                  type: number
                value:
                  type:
                    - number
                    - 'null'
                previous:
                  type:
                    - number
                    - 'null'
                series:
                  type: array
                  items:
                    type:
                      - number
                      - 'null'
              required:
                - 'n'
                - value
                - previous
                - series
            automation_rate:
              type: object
              properties:
                'n':
                  type: number
                value:
                  type:
                    - number
                    - 'null'
                previous:
                  type:
                    - number
                    - 'null'
                series:
                  type: array
                  items:
                    type:
                      - number
                      - 'null'
              required:
                - 'n'
                - value
                - previous
                - series
            topic_detected:
              type: object
              properties:
                'n':
                  type: number
                value:
                  type:
                    - number
                    - 'null'
                previous:
                  type:
                    - number
                    - 'null'
                series:
                  type: array
                  items:
                    type:
                      - number
                      - 'null'
              required:
                - 'n'
                - value
                - previous
                - series
            handoff_share:
              type: object
              properties:
                'n':
                  type: number
                value:
                  type:
                    - number
                    - 'null'
                previous:
                  type:
                    - number
                    - 'null'
                series:
                  type: array
                  items:
                    type:
                      - number
                      - 'null'
              required:
                - 'n'
                - value
                - previous
                - series
            not_routed:
              type: object
              properties:
                'n':
                  type: number
                value:
                  type:
                    - number
                    - 'null'
                previous:
                  type:
                    - number
                    - 'null'
                series:
                  type: array
                  items:
                    type:
                      - number
                      - 'null'
              required:
                - 'n'
                - value
                - previous
                - series
            median_first_response_aide:
              type: object
              properties:
                'n':
                  type: number
                value:
                  type:
                    - number
                    - 'null'
                previous:
                  type:
                    - number
                    - 'null'
                series:
                  type: array
                  items:
                    type:
                      - number
                      - 'null'
              required:
                - 'n'
                - value
                - previous
                - series
            median_first_response_human:
              type: object
              properties:
                'n':
                  type: number
                value:
                  type:
                    - number
                    - 'null'
                previous:
                  type:
                    - number
                    - 'null'
                series:
                  type: array
                  items:
                    type:
                      - number
                      - 'null'
              required:
                - 'n'
                - value
                - previous
                - series
            median_human_after_handoff:
              type: object
              properties:
                'n':
                  type: number
                value:
                  type:
                    - number
                    - 'null'
                previous:
                  type:
                    - number
                    - 'null'
                series:
                  type: array
                  items:
                    type:
                      - number
                      - 'null'
              required:
                - 'n'
                - value
                - previous
                - series
            median_time_to_resolution:
              type: object
              properties:
                'n':
                  type: number
                value:
                  type:
                    - number
                    - 'null'
                previous:
                  type:
                    - number
                    - 'null'
                series:
                  type: array
                  items:
                    type:
                      - number
                      - 'null'
              required:
                - 'n'
                - value
                - previous
                - series
            csat_aide:
              type: object
              properties:
                'n':
                  type: number
                value:
                  type:
                    - number
                    - 'null'
                previous:
                  type:
                    - number
                    - 'null'
                series:
                  type: array
                  items:
                    type:
                      - number
                      - 'null'
              required:
                - 'n'
                - value
                - previous
                - series
            csat_human:
              type: object
              properties:
                'n':
                  type: number
                value:
                  type:
                    - number
                    - 'null'
                previous:
                  type:
                    - number
                    - 'null'
                series:
                  type: array
                  items:
                    type:
                      - number
                      - 'null'
              required:
                - 'n'
                - value
                - previous
                - series
            verified_by_team:
              type: object
              properties:
                'n':
                  type: number
                value:
                  type:
                    - number
                    - 'null'
                previous:
                  type:
                    - number
                    - 'null'
                series:
                  type: array
                  items:
                    type:
                      - number
                      - 'null'
              required:
                - 'n'
                - value
                - previous
                - series
            billable_conversations:
              type: object
              properties:
                'n':
                  type: number
                value:
                  type:
                    - number
                    - 'null'
                previous:
                  type:
                    - number
                    - 'null'
                series:
                  type: array
                  items:
                    type:
                      - number
                      - 'null'
              required:
                - 'n'
                - value
                - previous
                - series
          required:
            - ai_resolution_rate
            - not_reopened
            - automation_rate
            - topic_detected
            - handoff_share
            - not_routed
            - median_first_response_aide
            - median_first_response_human
            - median_human_after_handoff
            - median_time_to_resolution
            - csat_aide
            - csat_human
            - verified_by_team
            - billable_conversations
        automation:
          type: object
          properties:
            full:
              type: number
            partial:
              type: number
          required:
            - full
            - partial
        handoffReasons:
          type: array
          items:
            type: object
            properties:
              count:
                type: number
              reason:
                type: string
                enum:
                  - customer_asked
                  - guardrail
                  - low_confidence
                  - manual
                  - missing_data
                  - policy
                  - unspecified
            required:
              - count
              - reason
        handoffReasonsByDay:
          type: array
          items:
            type: object
            properties:
              date:
                type: string
              reasons:
                type: object
                properties:
                  manual:
                    type: number
                  customer_asked:
                    type: number
                  low_confidence:
                    type: number
                  guardrail:
                    type: number
                  missing_data:
                    type: number
                  policy:
                    type: number
                  unspecified:
                    type: number
                required:
                  - manual
                  - customer_asked
                  - low_confidence
                  - guardrail
                  - missing_data
                  - policy
                  - unspecified
            required:
              - date
              - reasons
        handoffReasonsByChannel:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              slug:
                type: string
              reasons:
                type: object
                properties:
                  manual:
                    type: number
                  customer_asked:
                    type: number
                  low_confidence:
                    type: number
                  guardrail:
                    type: number
                  missing_data:
                    type: number
                  policy:
                    type: number
                  unspecified:
                    type: number
                required:
                  - manual
                  - customer_asked
                  - low_confidence
                  - guardrail
                  - missing_data
                  - policy
                  - unspecified
            required:
              - name
              - slug
              - reasons
        reviewedShare:
          type:
            - number
            - 'null'
        csatResponseRate:
          type: object
          properties:
            aide:
              type:
                - number
                - 'null'
            human:
              type:
                - number
                - 'null'
          required:
            - aide
            - human
        sales:
          type: object
          properties:
            viewThrough:
              type: object
              properties:
                orders:
                  type: object
                  properties:
                    value:
                      type: number
                    previous:
                      type: number
                  required:
                    - value
                    - previous
                revenue:
                  type: array
                  items:
                    type: object
                    properties:
                      value:
                        type: number
                      previous:
                        type: number
                      currency:
                        type: string
                    required:
                      - value
                      - previous
                      - currency
              required:
                - orders
                - revenue
            orders:
              type: object
              properties:
                value:
                  type: number
                previous:
                  type: number
              required:
                - value
                - previous
            revenue:
              type: array
              items:
                type: object
                properties:
                  value:
                    type: number
                  previous:
                    type: number
                  currency:
                    type: string
                required:
                  - value
                  - previous
                  - currency
          required:
            - viewThrough
            - orders
            - revenue
        interactions:
          type: object
          properties:
            manual:
              type: object
              properties:
                value:
                  type: number
                previous:
                  type: number
              required:
                - value
                - previous
            automated:
              type: object
              properties:
                value:
                  type: number
                previous:
                  type: number
              required:
                - value
                - previous
            byDay:
              type: array
              items:
                type: object
                properties:
                  date:
                    type: string
                  manual:
                    type: number
                  automated:
                    type: number
                required:
                  - date
                  - manual
                  - automated
          required:
            - manual
            - automated
            - byDay
      required:
        - object
        - topics
        - until
        - from
        - timezone
        - channels
        - previousFrom
        - previousUntil
        - asOf
        - seasonalBaseline
        - eligible
        - volumeByDay
        - resolution
        - metrics
        - automation
        - handoffReasons
        - handoffReasonsByDay
        - handoffReasonsByChannel
        - reviewedShare
        - csatResponseRate
        - sales
        - interactions
    Error:
      type: object
      description: Every error response, whatever the status (app/exceptions/handler.ts).
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - api_error
                - authentication_error
                - invalid_request_error
                - permission_error
                - rate_limit_error
            code:
              type: string
              description: Stable, machine-readable error code.
            message:
              type: string
            requestId:
              type: string
            fields:
              type: array
              description: Per-field problems, on validation errors.
              items:
                type: object
                properties:
                  field:
                    type: string
                  code:
                    type: string
                  message:
                    type: string
                required:
                  - field
                  - code
                  - message
          required:
            - type
            - code
            - message
            - requestId
      required:
        - error
  responses:
    Unauthenticated:
      description: Missing or invalid credentials (`authentication_error`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: The credential may not do this (`permission_error`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ValidationFailed:
      description: The request has invalid fields (`validation_failed`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    TooManyRequests:
      description: Rate limited (`too_many_requests`).
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        Retry-After:
          $ref: '#/components/headers/Retry-After'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error:
      description: Any other error, in the same envelope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    accessToken:
      type: http
      scheme: bearer
      bearerFormat: oat_…
      description: An access token, bound to one account.
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: aide_live_…
      description: >-
        A workspace API key. Acts as the workspace with the `read` and/or
        `write` scope; never as a teammate.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.