Skip to main content
GET
Get a manual-audience run

Authorizations

Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Headers

X-Brand-Id
string

The brand this request acts on. REQUIRED for organization-scoped credentials (otherwise 400 BRAND_ID_REQUIRED — there is no default brand); list ids with GET /v1/brands. Brand-scoped credentials may omit it, and sending a different brand returns 403 BRAND_SCOPE_MISMATCH. A brand outside your organization returns 404 BRAND_NOT_FOUND.

Required string length: 1 - 64

Path Parameters

audienceRunId
string
required

The audience run id (from POST /v1/automations/{automationId}/run or GET /v1/automations/audience-runs).

Required string length: 1 - 64
Example:

"arun_7acthhe99pq4448xh83gn54x8eennb"

Response

The manual-audience run.

audienceRunId
string
required
automationId
string
required
audienceId
string
required
status
enum<string>
required
Available options:
queued,
scheduled,
running,
paused,
completed,
failed,
canceled
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
automationName
string
audienceName
string
approvalState
enum<string>
Available options:
pending,
approved,
rejected
scheduledAt
string<date-time>
totalRecipients
number
sentCount
number
failedCount
number
skippedCount
number
nodeStats
object[]
gradualSend
object
error
string
stalledAt
string<date-time>
resumeGeneration
number
resumedAt
string<date-time>
startedAt
string<date-time>
completedAt
string<date-time>