Skip to main content
POST
Run Audit

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

brand_id
string<uuid>
required

Body

application/json
audit_type
string
required
platform
string | null

Response

Successful Response

id
string<uuid>
required
brand_id
string<uuid>
required
audit_type
string
required
status
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
platform
string | null
overall_score
number | null
summary
string | null
results
Results · object
recommendations
any[]
output_files
any[]
cost_usd
number
default:0
error_message
string | null
started_at
string<date-time> | null
completed_at
string<date-time> | null