Zapmail
latest
  • latest
  • v1
  1. placement test
Zapmail
latest
  • latest
  • v1
  • Zapmail Docs
  • users
    • Retrieve User Details
      GET
  • workspaces
    • Retrieve all workspaces
      GET
    • Create new workspace
      POST
    • Update workspace
      PUT
  • billing
    • Add Billing Details
      POST
    • Update Billing Details
      PUT
  • mailbox
    • Retrieve All Mailboxes
      GET
    • Get Mailbox Details by ID
      GET
    • Assign New Mailboxes to Domains
      POST
    • Update mailbox
      PUT
    • Remove mailboxes on next renewal
      PUT
    • Get Authenticator code
      GET
    • Remove Mailboxes Instantly
      POST
    • Custom OAuth
      POST
  • payments & wallet
    • Add balance to wallet
      POST
    • Get wallet balance
      GET
    • Enable auto recharge
      POST
  • export
    • Export mailboxes
    • Add third party account details
    • Update third party account details
  • subscriptions
    • Get all subscriptions
    • Cancel subscription
    • Upgrade existing subscription
    • Purchase subscription
  • domains
    • Retrieve All Domains
    • List Assignable Domains
    • Add DMARC record
    • Add Domain forwarding
    • Get Name servers to connect domain
    • Verify Name Server Propagation
    • Connect Domain with Zapmail
    • Enable email forwarding
    • Remove email forwarding
    • Enable catch all emails
    • Remove catch all emails
    • Check DNS records
    • Remove unused domains
    • Get available domains for registration
    • Get domains purchase payment link
    • Get domain connection requests
    • Remove domain connection requests
    • Connect Domain with Zapmail (New)
    • Add Google Client ID to Domain
    • Get availability of multiple domain names.
    • Retrieve Domain Health Score
  • dns
    • Get dns records
    • Add dns records
    • Update dns records
    • Delete dns records
  • aged domains
    • Get available domains
    • Purchase aged domains
  • prewarmed domains
    • Get prewarmed domains
    • purchase prewarmed subscription
    • Assign prewarmed mailboxes
  • placement test
    • Get subscriptions
      GET
    • Get Overall Report
      GET
    • Get placement test orders
      GET
    • Get report by cart order id
      GET
    • Get Eligible Mailboxes for Placement Tests
      POST
    • Get Available Placement Test Credits
      GET
    • Purchase Placement Test
      POST
    • Purchase plan
      POST
  • dns shield
    • Get eligible domains
    • Get available slots
    • Get subscriptions
    • Get Allocated Domains for Subscription
    • Allocate Domains to DNS Shield
    • Purchase DNS Shield
    • Upgrade DNS Shield LTD Plan
    • Cancel subscription
  • Schemas
    • domain with filter
  1. placement test

Get Overall Report

Testing
GET
/v2/placement-tests/overall-report
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.

Request

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.zapmail.ai/api/v2/placement-tests/overall-report' \
--header 'x-auth-zapmail;' \
--header 'x-workspace-key;' \
--header 'x-service-provider;'

Responses

🟢200Success
application/json
Body

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%"
  }
}
Modified at 2025-12-24 13:02:45
Previous
Get subscriptions
Next
Get placement test orders
Built with