Get Placement Reports

GET

/placement/reports

Returns paginated placement test reports for a user.

Results are grouped by orderId — one purchase of multiple mailboxes appears as a single report entry with a mailboxes array. The aggregate status reflects the worst-case across all mailboxes in the group.

Filtering:

Pass orderId to fetch a specific order group by OrderId.

Pass mailboxId to fetch all orders for a specific mailbox.

AI Insight: If aiInsightRequested is true while placing placement test order, the aiInsight field will be populated once generation is complete.

Request

Authorization

API Key

Add parameter in header

cmr-x-api-key

Example:

cmr-x-api-key: ********************

Query Params

Responses

🟢200Success

application/json

Paginated list of placement order groups, newest first.

Bodyapplication/json

🟠401Unauthorized

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://customers.coldmailreseller.com/api/v1/integration/placement/reports?userId=H8M9JV2S9HMPYFQW393AZHQVD4XM&orderId=7K2M9P4Q1R8S5T3U6V0W2X4Y8Z1A&mailboxId=GP6M2J2DHXM3F2J40S8AP316R2QR&page=1&limit=10' \
--header 'cmr-x-api-key: <api-key>'

Response Example

200 - Example 1

{
    "status": 200,
    "message": "Success",
    "data": {
        "data": [
            {
                "orderId": "7K2M9P4Q1R8S5T3U6V0W2X4Y8Z1A",
                "status": "PENDING",
                "spamassassin": true,
                "blacklist": true,
                "createdAt": "2026-08-08T10:30:00.000Z",
                "mailboxCount": 2,
                "mailboxes": [
                    {
                        "placementOrderId": "3N5P7Q9R1S4T6U8V",
                        "fromEmail": "john@acme.com",
                        "status": "PENDING",
                        "report": {
                            "inboxTest": {
                                "google": [
                                    {}
                                ],
                                "microsoft365": [
                                    {}
                                ]
                            },
                            "spamassassin": {},
                            "blacklist": {}
                        },
                        "aiInsightRequested": true,
                        "aiInsight": {
                            "summary": "Your domain has strong SPF/DKIM alignment. Sending volume is within safe limits.",
                            "riskLevel": "LOW",
                            "recommendations": [
                                "Enable DMARC policy",
                                "Reduce sending frequency by 20%"
                            ]
                        }
                    }
                ]
            }
        ],
        "totalCount": 5
    }
}

Modified at 2026-08-10 06:34:48

Create Placement Order

Errors