> ## 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 overall email reports



## OpenAPI

````yaml /openapi.json get /api/reports/email/overall
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/email/overall:
    get:
      tags:
        - reports
      summary: Get overall email reports
      operationId: get_api_reports_email_overall
      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:
                  campaignComparison:
                    items:
                      properties:
                        _id:
                          description: Campaign ID
                          type: string
                        name:
                          description: Campaign name
                          type: string
                        rates:
                          properties:
                            clicks:
                              description: Click rate
                              format: float
                              type: number
                            opens:
                              description: Open rate
                              format: float
                              type: number
                          type: object
                        scheduledAt:
                          description: Campaign scheduled at
                          format: date-time
                          type: string
                      type: object
                    type: array
                  deliveryTimeStats:
                    description: >-
                      Email delivery open rates by day time distribution
                      statistics.
                    properties:
                      afternoon:
                        description: >-
                          Percentage of open rate for delivered in the
                          afternoon. (10am-4pm)
                        example: 39.18
                        format: float
                        type: number
                      evening:
                        description: >-
                          Percentage of open rate for delivered in the evening.
                          (4pm-10pm)
                        example: 0
                        format: float
                        type: number
                      morning:
                        description: >-
                          Percentage of open rate for delivered in the morning.
                          (4am-10am)
                        example: 34.28
                        format: float
                        type: number
                      night:
                        description: >-
                          Percentage of open rate for delivered at night.
                          (10pm-4am)
                        example: 0
                        format: float
                        type: number
                    type: object
                  stats:
                    properties:
                      complaints:
                        description: Complaint emails statistics.
                        properties:
                          count:
                            properties:
                              diff:
                                description: >-
                                  Complaint count difference from previous
                                  period.
                                example: 100
                                format: float
                                type: number
                              prev:
                                description: Previous period complaint email count.
                                example: 5
                                type: integer
                              value:
                                description: Complaint count.
                                example: 10
                                type: integer
                            type: object
                        type: object
                      delivered:
                        description: Delivered emails statistics.
                        properties:
                          count:
                            properties:
                              diff:
                                description: >-
                                  Delivered email count difference from previous
                                  period.
                                example: -42.95
                                format: float
                                type: number
                              prev:
                                description: Previous period delivered email count.
                                example: 3722
                                type: integer
                              value:
                                description: Delivered email count.
                                example: 2611
                                type: integer
                            type: object
                        type: object
                      hardBounces:
                        description: Hard bounce emails statistics.
                        properties:
                          count:
                            properties:
                              diff:
                                description: >-
                                  Hard bounce email count difference from
                                  previous period.
                                example: -25.64
                                format: float
                                type: number
                              prev:
                                description: Previous period hard bounce email count.
                                example: 152
                                type: integer
                              value:
                                description: Hard bounce email count.
                                example: 116
                                type: integer
                            type: object
                          rate:
                            properties:
                              diff:
                                description: >-
                                  Hard bounce email rate difference from
                                  previous period.
                                example: 30.21
                                format: float
                                type: number
                              prev:
                                description: >-
                                  Previous period hard bounce email rate
                                  (bounces/sent).
                                example: 22.32
                                format: float
                                type: number
                              value:
                                description: Hard bounce email rate (bounces/sent).
                                example: 28.53
                                format: float
                                type: number
                            type: object
                        type: object
                      sent:
                        description: Sent emails statistics.
                        properties:
                          count:
                            properties:
                              diff:
                                description: >-
                                  Sent email count difference from previous
                                  period.
                                example: -42.28
                                format: float
                                type: number
                              prev:
                                description: Previous period sent email count.
                                example: 3942
                                type: integer
                              value:
                                description: Sent email count.
                                example: 2822
                                type: integer
                            type: object
                        type: object
                      softBounces:
                        description: Soft bounce emails statistics.
                        properties:
                          count:
                            properties:
                              diff:
                                description: >-
                                  Soft bounce email count difference from
                                  previous period.
                                example: -39.1
                                format: float
                                type: number
                              prev:
                                description: Previous period soft bounce email count.
                                example: 125
                                type: integer
                              value:
                                description: Soft bounce email count.
                                example: 95
                                type: integer
                            type: object
                          rate:
                            properties:
                              diff:
                                description: >-
                                  Soft bounce email rate difference from
                                  previous period.
                                example: 30.21
                                format: float
                                type: number
                              prev:
                                description: >-
                                  Previous period soft bounce email rate
                                  (bounces/sent).
                                example: 22.32
                                format: float
                                type: number
                              value:
                                description: Soft bounce email rate (bounces/sent).
                                example: 28.53
                                format: float
                                type: number
                            type: object
                        type: object
                      totalBounces:
                        description: Total bounce emails statistics.
                        properties:
                          count:
                            properties:
                              diff:
                                description: >-
                                  Total bounce email count difference from
                                  previous period.
                                example: -25.64
                                format: float
                                type: number
                              prev:
                                description: Previous period total bounce email count.
                                example: 152
                                type: integer
                              value:
                                description: Total bounce email count.
                                example: 116
                                type: integer
                            type: object
                          rate:
                            properties:
                              diff:
                                description: >-
                                  Total bounce email rate difference from
                                  previous period.
                                example: 30.21
                                format: float
                                type: number
                              prev:
                                description: >-
                                  Previous period total bounce email rate
                                  (bounces/sent).
                                example: 22.32
                                format: float
                                type: number
                              value:
                                description: Total bounce email rate (bounces/sent).
                                example: 28.53
                                format: float
                                type: number
                            type: object
                        type: object
                      uniqueClicks:
                        description: Unique clicked emails statistics.
                        properties:
                          count:
                            properties:
                              diff:
                                description: >-
                                  Unique clicked email count difference from
                                  previous period.
                                example: -25.72
                                format: float
                                type: number
                              prev:
                                description: Previous period unique clicked email count.
                                example: 1283
                                type: integer
                              value:
                                description: Unique clicked email count.
                                example: 745
                                type: integer
                            type: object
                          rate:
                            properties:
                              diff:
                                description: >-
                                  Unique clicked email rate difference from
                                  previous period.
                                example: 30.21
                                format: float
                                type: number
                              prev:
                                description: >-
                                  Previous period unique clicked email rate
                                  (clicks/delivered).
                                example: 22.32
                                format: float
                                type: number
                              value:
                                description: Unique clicked email rate (clicks/delivered).
                                example: 28.53
                                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: -28.34
                                format: float
                                type: number
                              prev:
                                description: Previous period unique opened email count.
                                example: 1283
                                type: integer
                              value:
                                description: Unique opened email count.
                                example: 971
                                type: integer
                            type: object
                          rate:
                            properties:
                              diff:
                                description: >-
                                  Unique opened email rate difference from
                                  previous period.
                                example: 25.64
                                format: float
                                type: number
                              prev:
                                description: >-
                                  Previous period unique opened email rate
                                  (opens/delivered).
                                example: 27.32
                                format: float
                                type: number
                              value:
                                description: Unique opened email rate (opens/delivered).
                                example: 37.19
                                format: float
                                type: number
                            type: object
                        type: object
                      unsubscribes:
                        description: Unsubscribed emails statistics.
                        properties:
                          count:
                            properties:
                              diff:
                                description: >-
                                  Unsubscribe count difference from previous
                                  period.
                                example: -25
                                format: float
                                type: number
                              prev:
                                description: Previous period unsubscribed email count.
                                example: 125
                                type: integer
                              value:
                                description: Unsubscribe count.
                                example: 100
                                type: integer
                            type: object
                        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

````