Brand mentions

List brand mentions

Returns every brand mention detected across the active project. The response is paginated, with the newest mentions returned first by default.

GET /api/v1/brand-mentions

Query parameters

Name Type Required Description
page integer Optional

The page number to return. Defaults to 1.
per_page integer Optional

The number of items per page. Defaults to 25, maximum 100.
response_id integer Optional

Limit results to mentions on a single response.
brand_id integer Optional

Limit results to mentions of a single brand.
sort_by string Optional

The column to sort by. Defaults to created_at.
sort_order string Optional

The direction to sort by. Each endpoint has its own default.
include string Optional

A comma-separated list of related resources to include in the response. Allowed values: response, response.prompt, response.monitor, response.project, brand, brand.project, brand.project.organization.

Response

Response schema

Field Type Description
data BrandMention[]
links PaginationLinks
meta PaginationMeta

The brand-mention object

Field Type Description
id integer

The unique ID of the brand mention.
position integer

The one-indexed order in which the brand appeared in the response. A position of 1 means the brand was mentioned first.
sentiment_score integer

The sentiment score on a 0-100 scale, where 50 is neutral, 0 is strongly negative, and 100 is strongly positive.
created_at datetime

When the brand mention was recorded.
updated_at datetime

When the brand mention was last updated.