Get Inbox Test Results
The get_inbox_test_results API allows you to retrieve the placement results for an inbox test created via the create_inbox_test API. Results are populated as seed mailboxes receive your campaign, so you may call this endpoint multiple times until the status is Completed.
A status of Processing means not all seed mailboxes have received your campaign yet. Check back in a few minutes. If some seeds never receive the email, the status will remain Processing — ensure your campaign was sent to all addresses in the send_to list.
Header:
X-CC-API-Key: Your API Key
Request Body:
Required:
- job_id: The job ID returned from the create_inbox_test API.
Response:
-
job_id: The unique ID of the inbox test.
-
test_name: The name of the inbox test.
-
submitted_date: The date and time the test was created.
-
submitted_by: The email address of the account that created the test.
-
status: Either Processing or Completed.
-
summary: A high-level breakdown of results.
- total_seeds: The total number of seed mailboxes in the test.
- received: The number of seeds that have received the campaign so far.
- inbox: The number of seeds where the campaign landed in the inbox.
- spam: The number of seeds where the campaign landed in spam or junk.
- unknown_placement: The number of seeds that received the email but placement could not be determined.
- pending: The number of seeds still waiting to receive the campaign.
- inbox_rate: The percentage of total seeds where the campaign landed in the inbox.
- spam_rate: The percentage of total seeds where the campaign landed in spam.
-
results: A detailed per-seed breakdown.
- provider: The email provider name (e.g. Gmail, Outlook, Yahoo).
- seed_address: The seed email address.
- email_found: (true/false) Whether the campaign was received by this seed.
- placement: Where the campaign landed - Inbox, Spam, or Pending.
- spf_status: The SPF authentication result for this seed.
- sender_ip: The IP address the campaign was sent from.
- submission_result: Additional detail about the submission result for this seed.
In the event of an error, you will get an “error:” response with a description of the reason.