Skip to main content
POST
Attribute Observations

Authorizations

x-api-key
string
header
required

API key for authentication. You can create one here.

Body

application/json
website_id
string<uuid>
required
filters
object
required

The shared filters without competitor_ids, for the brand trait endpoints that do not take it: /api/v1/attributes/cumulative is brand-only, and /api/v1/attributes/observations selects entities with entity_ids. Sending competitor_ids is rejected. Use /api/v1/attributes/competitors for per-competitor metrics.

entity_ids
string<uuid>[]

Entities to return observations for: the website_id for your brand, or competitor ids from GET /api/v1/competitors. Omit for every entity.

Maximum array length: 100
attribute_ids
string<uuid>[]

Attributes to return observations for, from GET /api/v1/attributes. Omit for every active attribute.

Maximum array length: 100
positive
boolean

true for favorable observations only, false for critical ones only. Omit for both directions.

sort
enum<string>
default:intensity

intensity: strongest first, unscored last, then newest. recent: newest first.

Available options:
intensity,
recent
page_num
integer
default:0

Zero-indexed page number.

Required range: x >= 0
page_size
integer
default:40

Rows per page.

Required range: 1 <= x <= 100

Response

Successful response with a page of observations

data
object[]
required
page_num
integer
required

Zero-indexed page number returned.

page_size
integer
required

Maximum rows per page.

has_more
boolean
required

true if another page is available.