Skip to main content
POST
Get Brand Intelligence Board Commentary Route

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
ad_ids
string<uuid>[]
required
Required array length: 1 - 200 elements
board_label
string | null
Maximum string length: 120
refresh
boolean
default:false

Response

Successful Response

group_key
string
required
generated_at
string<date-time>
required
period
string
required
prompt_version
string
required
schema_version
string
required
status
enum<string>
default:ready
Available options:
ready,
pending
summary
string
default:""
Maximum string length: 600
weekly
BrandIntelligenceInsight · object[]
Maximum array length: 6
monthly
BrandIntelligenceInsight · object[]
Maximum array length: 6
recommendations
BrandIntelligenceInsight · object[]
Maximum array length: 6
source_refs
Source Refs · object
provenance
Provenance · object
fallback_reason
string | null
refresh_available_at
string<date-time> | null