# Get Overall Report

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v2/placement-tests/overall-report:
    get:
      summary: Get Overall Report
      deprecated: false
      description: >-
        Retrieve an overall summary of all placement test results. This endpoint
        aggregates data across all your placement tests, providing insights into
        email deliverability performance across different providers and
        mailboxes.
      tags:
        - placement test
      parameters:
        - name: x-auth-zapmail
          in: header
          description: ''
          required: true
          example: ''
          schema:
            type: string
        - name: x-workspace-key
          in: header
          description: ''
          required: false
          example: ''
          schema:
            type: string
        - name: x-service-provider
          in: header
          description: ''
          required: false
          example: ''
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      totalTestRuns:
                        type: integer
                      totalEmails:
                        type: integer
                      successfulTestsCount:
                        type: integer
                      inProgressTestsCount:
                        type: integer
                      failedTestsCount:
                        type: integer
                      successfulEmailsCount:
                        type: integer
                      inboxCount:
                        type: integer
                      inboxRate:
                        type: string
                      spamCount:
                        type: integer
                      spamRate:
                        type: string
                      bounceCount:
                        type: integer
                      bounceRate:
                        type: string
                      otherTabsCount:
                        type: integer
                      otherTabsRate:
                        type: string
                      blacklistedCount:
                        type: integer
                      blacklistedRate:
                        type: string
                      issuesFlagged:
                        type: integer
                      issuesFlaggedRate:
                        type: string
                      authPassCount:
                        type: integer
                      authPassRate:
                        type: string
                      summary:
                        type: object
                        properties:
                          totalTests:
                            type: integer
                          totalMailboxes:
                            type: integer
                          averageInboxRate:
                            type: number
                          averageSpamRate:
                            type: number
                          overallScore:
                            type: number
                        required:
                          - totalTests
                          - totalMailboxes
                          - averageInboxRate
                          - averageSpamRate
                          - overallScore
                        x-apidog-orders:
                          - totalTests
                          - totalMailboxes
                          - averageInboxRate
                          - averageSpamRate
                          - overallScore
                      byProvider:
                        type: array
                        items:
                          type: object
                          properties:
                            provider:
                              type: string
                            testsCount:
                              type: integer
                            inboxRate:
                              type: number
                            spamRate:
                              type: number
                            score:
                              type: number
                          required:
                            - provider
                            - testsCount
                            - inboxRate
                            - spamRate
                            - score
                          x-apidog-orders:
                            - provider
                            - testsCount
                            - inboxRate
                            - spamRate
                            - score
                      recentTests:
                        type: array
                        items:
                          type: object
                          properties:
                            testId:
                              type: string
                            testName:
                              type: string
                            mailboxEmail:
                              type: string
                            completedAt:
                              type: string
                            inboxRate:
                              type: integer
                            spamRate:
                              type: integer
                            score:
                              type: number
                            status:
                              type: string
                          required:
                            - testId
                            - testName
                            - mailboxEmail
                            - completedAt
                            - inboxRate
                            - spamRate
                            - score
                            - status
                          x-apidog-orders:
                            - testId
                            - testName
                            - mailboxEmail
                            - completedAt
                            - inboxRate
                            - spamRate
                            - score
                            - status
                      pagination:
                        type: object
                        properties:
                          currentPage:
                            type: integer
                          totalPages:
                            type: integer
                          totalCount:
                            type: integer
                          limit:
                            type: integer
                          hasNextPage:
                            type: boolean
                          hasPreviousPage:
                            type: boolean
                        required:
                          - currentPage
                          - totalPages
                          - totalCount
                          - limit
                          - hasNextPage
                          - hasPreviousPage
                        x-apidog-orders:
                          - currentPage
                          - totalPages
                          - totalCount
                          - limit
                          - hasNextPage
                          - hasPreviousPage
                    required:
                      - totalTestRuns
                      - totalEmails
                      - successfulTestsCount
                      - inProgressTestsCount
                      - failedTestsCount
                      - successfulEmailsCount
                      - inboxCount
                      - inboxRate
                      - spamCount
                      - spamRate
                      - bounceCount
                      - bounceRate
                      - otherTabsCount
                      - otherTabsRate
                      - blacklistedCount
                      - blacklistedRate
                      - issuesFlagged
                      - issuesFlaggedRate
                      - authPassCount
                      - authPassRate
                      - summary
                      - byProvider
                      - recentTests
                      - pagination
                    x-apidog-orders:
                      - totalTestRuns
                      - totalEmails
                      - successfulTestsCount
                      - inProgressTestsCount
                      - failedTestsCount
                      - successfulEmailsCount
                      - inboxCount
                      - inboxRate
                      - spamCount
                      - spamRate
                      - bounceCount
                      - bounceRate
                      - otherTabsCount
                      - otherTabsRate
                      - blacklistedCount
                      - blacklistedRate
                      - issuesFlagged
                      - issuesFlaggedRate
                      - authPassCount
                      - authPassRate
                      - summary
                      - byProvider
                      - recentTests
                      - pagination
                required:
                  - status
                  - message
                  - data
                x-apidog-orders:
                  - status
                  - message
                  - data
              example:
                status: 200
                message: Overall placement test report fetched successfully
                data:
                  totalTestRuns: 5
                  totalEmails: 81
                  successfulTestsCount: 1
                  inProgressTestsCount: 5
                  failedTestsCount: 0
                  successfulEmailsCount: 3
                  inboxCount: 3
                  inboxRate: 100.00%
                  spamCount: 0
                  spamRate: 0.00%
                  bounceCount: 0
                  bounceRate: 0.00%
                  otherTabsCount: 0
                  otherTabsRate: 0.00%
                  blacklistedCount: 0
                  blacklistedRate: 0.00%
                  issuesFlagged: 3
                  issuesFlaggedRate: 100.00%
                  authPassCount: 1
                  authPassRate: 33.33%
          headers: {}
          x-apidog-name: Success
        '401':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  message:
                    type: string
                  errorId:
                    type: string
                required:
                  - status
                  - message
                  - errorId
                x-apidog-orders:
                  - status
                  - message
                  - errorId
              example:
                status: 401
                message: API key is required
                errorId: uuid-v4-error-id
          headers: {}
          x-apidog-name: Unauthorized
        '500':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  message:
                    type: string
                  errorId:
                    type: string
                required:
                  - status
                  - message
                  - errorId
                x-apidog-orders:
                  - status
                  - message
                  - errorId
              example:
                status: 500
                message: Internal server error
                errorId: uuid-v4-error-id
          headers: {}
          x-apidog-name: Internal Server Error
      security: []
      x-apidog-folder: placement test
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797058/apis/api-25778661-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://api.zapmail.ai/api
    description: Prod Env
security: []

```