> ## Documentation Index > Fetch the complete documentation index at: https://docs.campaigncleaner.com/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml POST /v1/get_inbox_test_results openapi: 3.0.0 info: title: API DOCUMENTATION description: >- [Campaign Cleaner](https://campaigncleaner.com) is the leader in ensuring that your campaigns don't affect your IP and Domain reputation, it's the most advanced toolset you'll find that gives you all the tools you need to keep your campaigns within acceptable ratios of many email and spam filtering software and automatically fixes your HTML by sanitizing all non-email friendly attributes and inlines all your CSS to be compatible with every email client. We offer a robust collection of API's to allow you to integrate its functionality into your email marketing software and tools. The **{{api_key}}** is located in your account on [Campaign Cleaner](https://campaigncleaner.com) under **API Management API Keys.** Use the navigation on the left to access the different API Endpoints. version: 1.0.0 servers: - url: https://api.campaigncleaner.com security: [] paths: /v1/get_inbox_test_results: post: tags: - Campaign Cleaner summary: Get Inbox Test Results description: >- 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. parameters: - name: X-CC-API-Key in: header schema: type: string example: '{{api_key}}' requestBody: content: application/json: schema: type: object properties: job_id: type: string example: job_id: '12345' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: job_id: '12345' test_name: My Campaign Inbox Test submitted_date: '2024-04-24T10:30:00' submitted_by: user@example.com status: Completed summary: total_seeds: 30 received: 28 inbox: 24 spam: 3 unknown_placement: 1 pending: 2 inbox_rate: 80 spam_rate: 10 results: - provider: Gmail seed_address: seed1@gmail.com email_found: true placement: Inbox spf_status: pass sender_ip: 192.168.1.1 submission_result: '' - provider: Outlook seed_address: seed2@outlook.com email_found: true placement: Spam spf_status: pass sender_ip: 192.168.1.1 submission_result: '' - provider: Yahoo seed_address: seed3@yahoo.com email_found: false placement: Pending spf_status: '' sender_ip: '' submission_result: '' ````