Skip to main content
POST
Run a data command

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

Body

application/json
command
string
required

Bash command line, e.g.: db find audiences name=vip --fields name | jq -r '.name'

Required string length: 1 - 4000

Response

Command result. exitCode 0 = success; non-zero = the command failed (message in output).

exitCode
integer
required

0 = success; non-zero = the command failed (see output)

output
string
required

stdout, then stderr under a [stderr] marker when present. Row contents are customer data.

truncated
boolean
required

true when the output was cut at the size budget