The brand object

A brand is an entity Pineprompt matches against platform answers: your own brand, a competitor you track, or a brand discovered in an answer. Matches are found through the display name, the aliases, and the domains.

Fields

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.
project	Project	The parent project. Returned when requested via `include=project` or `include=project.organization`.
created_at	datetime	When the brand was created.
updated_at	datetime	When the brand was last updated.

{ "id": 555, "project_id": 42, "display_name": "Acme Inc.", "aliases": [ "Acme", "Acme Co" ], "domains": [ "acme.com", "acme.co" ], "kind": "competitor", "color": "#008FFB", "ignored_at": null, "project": { "id": 42, "organization_id": 7, "name": "Acme Marketing", "brand_id": 555, "organization": { "id": 7, "name": "Acme Inc.", "created_at": "2026-05-15T09:11:42+00:00", "updated_at": "2026-05-15T09:11:42+00:00" }, "created_at": "2026-05-15T09:11:42+00:00", "updated_at": "2026-05-15T09:11:42+00:00" }, "created_at": "2026-05-15T09:11:42+00:00", "updated_at": "2026-05-15T09:11:42+00:00" }