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

# Get dashboard snapshot reports



## OpenAPI

````yaml /openapi.json get /api/reports/dashboard
openapi: 3.0.0
info:
  description: >-
    Public REST API for Benchmark Email.


    Authenticate every request by including your API key in the `X-API-Key`
    header.

    Each key is issued with one or more scopes that control which endpoints it
    may call.


    Rate limits: 60 requests per minute per account.

    Monthly quota: determined by your subscription plan.
  title: Benchmark Email API
  version: 1.0.0
servers:
  - description: >-
      Your account's API base URL. Copy the full URL shown on Settings > API
      Keys in your Benchmark Email account and paste it here.
    url: '{apiBaseUrl}'
    variables:
      apiBaseUrl:
        default: ''
        description: >-
          Your account's API base URL. Copy it from Settings > API Keys in your
          Benchmark Email account.
security:
  - apiKeyAuth: []
tags:
  - description: Contact related endpoints
    name: contact
  - description: Contact structure related endpoints
    name: contact-structure
  - description: List related endpoints
    name: lists
  - description: Email domain related endpoints
    name: email-domain
  - description: Email campaign related endpoints
    name: email-campaign
  - description: Email template related endpoints
    name: email-template
  - description: Report related endpoints
    name: reports
paths:
  /api/reports/dashboard:
    get:
      tags:
        - reports
      summary: Get dashboard snapshot reports
      operationId: get_api_reports_dashboard
      parameters:
        - description: >-
            The number of past days (between 1 and 90) to retrieve report stats
            and precedent stats.
          in: query
          name: pastDays
          required: true
          schema:
            maximum: 90
            minimum: 1
            type: integer
        - description: The user timezone (IANA) code.
          in: query
          name: timezone
          required: false
          schema:
            default: UTC
            example: America/La_Paz
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  campaign:
                    description: campaign reports
                    properties:
                      delivered:
                        description: delivered emails statistics.
                        properties:
                          count:
                            description: delivered email count.
                            example: 2203
                            type: integer
                          diff:
                            description: delivered email difference from previous period.
                            example: 11.3
                            format: float
                            type: number
                        type: object
                      sent:
                        description: sent emails statistics.
                        properties:
                          count:
                            description: sent email count.
                            example: 2379
                            type: integer
                          diff:
                            description: sent email difference from previous period.
                            example: 0.76
                            format: float
                            type: number
                        type: object
                      uniqueClicks:
                        description: clicked emails statistics.
                        properties:
                          count:
                            properties:
                              diff:
                                description: >-
                                  unique clicked email count difference from
                                  previous period.
                                example: -21.52
                                format: float
                                type: number
                              value:
                                description: unique clicked email count
                                example: 569
                                type: integer
                            type: object
                          rate:
                            properties:
                              diff:
                                description: >-
                                  unique clicked email rate difference from
                                  previous period.
                                example: 20.47
                                format: float
                                type: number
                              value:
                                description: unique clicked email rate (opens/delivered)
                                example: 25.83
                                format: float
                                type: number
                            type: object
                        type: object
                      uniqueOpens:
                        description: unique opened emails statistics.
                        properties:
                          count:
                            properties:
                              diff:
                                description: >-
                                  unique opened email count difference from
                                  previous period.
                                example: -23.41
                                format: float
                                type: number
                              value:
                                description: unique opened email count
                                example: 733
                                type: integer
                            type: object
                          rate:
                            properties:
                              diff:
                                description: >-
                                  unique opened email rate difference from
                                  previous period.
                                example: -22.41
                                format: float
                                type: number
                              value:
                                description: unique opened email rate (opens/delivered)
                                example: 33.27
                                format: float
                                type: number
                            type: object
                        type: object
                    type: object
                  contact:
                    properties:
                      count:
                        properties:
                          diff:
                            description: contact count diff from past time period
                            example: 29.55
                            format: float
                            type: number
                          value:
                            description: current contact count
                            example: 5900
                            type: number
                        type: object
                      histogram:
                        properties:
                          end:
                            description: contact snapshot histogram end date point
                            example: '2024-10-29T00:00:00.000Z'
                            format: date-time
                            type: string
                          histogram:
                            items:
                              properties:
                                date:
                                  example: '2024-09-23T17:00:00.000Z'
                                  format: date-time
                                  type: string
                                total:
                                  example: 4
                                  type: integer
                              type: object
                            type: array
                          peak:
                            properties:
                              date:
                                example: '2024-09-23T17:00:00.000Z'
                                format: date-time
                                type: string
                              total:
                                example: 4
                                type: integer
                            type: object
                          start:
                            description: contact snapshot histogram start date point
                            example: '2024-09-29T00:00:00.000Z'
                            format: date-time
                            type: string
                        type: object
                    type: object
                type: object
          description: Successfully report retrieved
      security:
        - apiKeyAuth: []
components:
  securitySchemes:
    apiKeyAuth:
      description: API key authentication
      in: header
      name: X-API-Key
      type: apiKey

````