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

# Get environment-wide analytics

> Subscriber counts, opt-outs, send outcomes, and bounce breakdown for an environment. `days` scopes the new-subscriber and recently-opted-out counts; send/bounce totals are all-time.



## OpenAPI

````yaml /openapi.json get /analytics
openapi: 3.1.0
info:
  title: subscriber.dev API
  description: >-
    Trigger workflows, manage subscribers and send broadcasts. Authenticate with
    an API key in the X-API-Key header: the key decides the environment. Docs:
    https://docs.subscriber.dev
  version: '1.0'
  contact: {}
servers:
  - url: https://api.subscriber.dev
    description: Cloud
security: []
tags: []
paths:
  /analytics:
    get:
      tags:
        - Analytics
      summary: Get environment-wide analytics
      description: >-
        Subscriber counts, opt-outs, send outcomes, and bounce breakdown for an
        environment. `days` scopes the new-subscriber and recently-opted-out
        counts; send/bounce totals are all-time.
      operationId: getAnalytics
      parameters:
        - name: days
          required: false
          in: query
          schema:
            minimum: 1
            maximum: 365
            default: 30
            type: number
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsResponse'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Environment not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limited. Wait a second and retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearer: []
        - api-key:
            - analytics:read
components:
  schemas:
    AnalyticsResponse:
      type: object
      properties:
        days:
          type: number
        subscribers:
          type: object
          properties:
            total:
              type: number
            newInPeriod:
              type: number
            optedOut:
              type: number
            optedOutInPeriod:
              type: number
          required:
            - total
            - newInPeriod
            - optedOut
            - optedOutInPeriod
        sends:
          type: object
          properties:
            sent:
              type: number
            failed:
              type: number
            skipped:
              type: number
            pending:
              type: number
            bounced:
              type: number
            successRate:
              type:
                - number
                - 'null'
          required:
            - sent
            - failed
            - skipped
            - pending
            - bounced
            - successRate
        bounces:
          type: object
          properties:
            hard:
              type: number
            soft:
              type: number
          required:
            - hard
            - soft
      required:
        - days
        - subscribers
        - sends
        - bounces
    ErrorResponse:
      type: object
      properties:
        statusCode:
          type: integer
          example: 404
        message:
          type: string
          example: Workflow not found
        error:
          type: string
          example: Not Found
        errors:
          description: Which fields failed validation, on a 400.
          type: array
          items:
            type: object
            properties:
              path:
                type: array
                items:
                  anyOf:
                    - type: string
                    - type: number
              message:
                type: string
              code:
                type: string
            required:
              - path
              - message
      required:
        - statusCode
        - message
  securitySchemes:
    bearer:
      scheme: bearer
      type: http
      description: >-
        A session token from `subscriber login`, used by subscriber.dev's own
        apps. Requests about an environment also need its ID in the
        `x-environment-id` header. From your own code, use an API key.
    api-key:
      type: apiKey
      in: header
      name: X-API-Key
      description: An environment API key. Keep it on your server.

````

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