Brands

List brands

Returns every brand belonging to the active project. The response is paginated.

GET /api/v1/brands

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.
sort_by string Optional

The column to sort by. Defaults to display_name.
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: project, project.organization.

Response

Response schema

Field Type Description
data Brand[]
links PaginationLinks
meta PaginationMeta

The brand object

Field Type Description
id integer

The unique ID of the brand.
project_id integer

The ID of the project the brand belongs to.
display_name string

The canonical display name of the brand.
aliases string[]

Alternative names that the brand is referred to by.
domains string[]

The web domains associated with the brand.
kind string

The brand's classification, derived from its context rather than stored: the brand the project's brand_id points at is own, a brand with ignored_at set is ignored, a brand attached to any segment is a competitor, and a brand with none of those is discovered. This field is read-only.
color string

A hex color used to color the brand consistently across charts. It is derived from the brand's favicon, or assigned automatically when no color can be derived. This field is read-only and is always present.
ignored_at datetime

When the brand was ignored, or null while it is not. Set and cleared through the ignored field on the update endpoint.
created_at datetime

When the brand was created.
updated_at datetime

When the brand was last updated.