Skip to main content
GET
Get Brand Segments

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer hrld_....

Path Parameters

brand_id
string<uuid>
required

Query Parameters

as_of
string<uuid> | null

Include only scans up to this completed scan id.

include_retired
boolean
default:false
sort
enum<string>
default:mentioned
Available options:
mentioned,
recommended,
prompts,
change

Response

Successful Response

comparison
SegmentsTable · object | null
required
meta
Meta · object
required

Normalized query and newest included scan.

personas
PersonaRow · object[]
required
segment_limit
integer
required
segment_limit_note
string | null
required
segments
SegmentRow · object[]
required
vocabulary
SegmentVocabulary · object
required