Skip to main content
GET
Get inbox placement results

Authorizations

Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Path Parameters

emailId
string
required

Design id returned by POST /v1/emails and listed by GET /v1/emails.

Required string length: 1 - 64
Example:

"eml_2SmZOWV3ZQ7W5x6g3m4p"

Query Parameters

testId
string

The test id returned by the create endpoint; omit to list the design's recent tests.

Required string length: 1 - 80
Example:

"ibp_2f1c9d8a-4e77-4b0e-9a1c-6d5e2f0b7c31"

Response

With testId: the test resource. Without: { data: [lean test rows] }.

testId
string
required
emailId
string
required
status
enum<string>
required
Available options:
pending,
sending,
collecting,
completed,
partial,
failed
domainId
string
required
seedCount
integer
required
Required range: x >= 0
results
object | null
required
createdAt
string
required
updatedAt
string
required
subject
string
previewText
string
emailVersionId
string
diagnosis
object[]
errorMessage
string