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

# Report: overview



## OpenAPI

````yaml https://api.apyconnect.io/v1/openapi.json get /v1/analytics/overview
openapi: 3.1.0
info:
  title: ApyConnect API
  version: 1.0.0
  description: >-
    ApyConnect public API. OAuth 2.0 authentication (client_credentials grant)
    with opaque Bearer tokens. Wrapped responses ({data, meta} / {object:'list',
    data, pagination, meta}); typed errors with trace_id; cursor pagination;
    snake_case throughout the JSON. Rate limit per Application.


    Best practices: send an `Idempotency-Key` header on writes to make retries
    safe (the same key replays the stored response for 24h; reusing a key with a
    different body returns 409). Use `?expand=contact` (and `expand=company` on
    deals) to embed related resources and save round-trips. Deprecated endpoints
    carry RFC 8594 `Deprecation`/`Sunset` headers. Inspect usage at `/v1/usage`
    and the write audit trail at `/v1/audit-logs`.
  contact:
    name: ApyConnect
    url: https://docs.apyconnect.io
servers:
  - url: https://api.apyconnect.io
    description: Production
security:
  - bearerAuth: []
tags:
  - name: OAuth
  - name: Contacts
  - name: Conversations
  - name: Messages
  - name: Channels
  - name: Inboxes
  - name: Campaigns
  - name: Analytics
  - name: Webhooks
  - name: Deals
  - name: Tasks
  - name: Companies
  - name: Tickets
  - name: Notes
  - name: Segments
  - name: Macros
  - name: Settings
  - name: Jobs
  - name: Observability
paths:
  /v1/analytics/overview:
    get:
      tags:
        - Analytics
      summary: 'Report: overview'
      parameters:
        - name: from
          in: query
          schema:
            type: string
            format: date
          description: 'Range start (ISO date). Default: 30 days ago.'
        - name: to
          in: query
          schema:
            type: string
            format: date
          description: 'Exclusive range end. Default: tomorrow.'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/AnalyticsReport'
                  meta:
                    $ref: '#/components/schemas/Meta'
                required:
                  - data
                  - meta
        '401':
          description: authentication_error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: permission_error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: rate_limit_error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    AnalyticsReport:
      type: object
      description: >-
        Aggregated report. Shape depends on the endpoint
        (overview/service/sla/...).
      properties:
        object:
          type: string
        range:
          type: object
          properties:
            from:
              type: string
            to:
              type: string
      additionalProperties: true
    Meta:
      type: object
      properties:
        request_id:
          type: string
      required:
        - request_id
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - rate_limit_error
                - not_found_error
                - conflict_error
                - api_error
            code:
              type: string
            message:
              type: string
            trace_id:
              type: string
            details: {}
          required:
            - type
            - code
            - message
            - trace_id
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Opaque token issued by /oauth/token.

````