Skip to main content
POST
/
api
/
v1
/
brands
/
{brand_id}
/
audits
Run Audit
curl --request POST \
  --url https://api.example.com/api/v1/brands/{brand_id}/audits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "audit_type": "<string>",
  "platform": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "audit_type": "<string>",
  "status": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "platform": "<string>",
  "overall_score": 123,
  "summary": "<string>",
  "results": {},
  "recommendations": [
    "<unknown>"
  ],
  "output_files": [
    "<unknown>"
  ],
  "cost_usd": 0,
  "error_message": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}

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