--- title: "Get a brand mention" method: GET path: "/api/v1/brand-mentions/{brandMention}" tags: ["brand-mentions"] --- # Get a brand mention `GET /api/v1/brand-mentions/{brandMention}` ## Request - Base URL: `https://pineprompt.com` - URL: `https://pineprompt.com/api/v1/brand-mentions/{brandMention}` - Auth: HTTP bearer Returns a single brand mention. The mention must belong to a response in the active project. ## Path parameters - `brandMention` integer, required ## Query parameters - `include` string ## Headers - `Pineprompt-Project-Id` integer, required ## Response `200` OK - BrandMention: A brand mention is a single appearance of a tracked brand inside a response, recorded with its position in the answer and its sentiment score. - `id` integer: The unique ID of the brand mention. - `response_id` integer: The numeric ID of the response the brand was mentioned in. You may pass this ID to the `response_id` filter on the list endpoint. - `brand_id` integer: The numeric ID of the brand that was mentioned. You may pass this ID to the `brand_id` filter on the list endpoint. - `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. - `response` Response: A response is one captured answer from an AI platform to one prompt on a single daily run. It carries the rendered content, the model that produced it, the monitor's country and language, and any search queries the platform issued. - `id` integer: The unique ID of the response. - `prompt_id` integer: The numeric ID of the prompt that produced this response. You may pass this ID to the `prompt_id` filter on the list endpoint. - `monitor_id` integer: The numeric ID of the monitor this response ran under. - `prompt_text` string: The exact prompt text the platform was given. - `platform` string: The AI platform that produced this answer. - `model` string: The model identifier reported by the platform. - `country` string: The ISO 3166-1 alpha-2 country code the response was run in. - `language` string: The language the response was run in. - `content` string: The raw markdown content the platform produced. - `html` string: The rendered HTML form of the content, suitable for display. - `excerpt` string: A whitespace-collapsed plain-text excerpt of the content, suitable for list views. - `search_queries` string[], nullable: The web search queries the platform ran while producing this answer, if any. - `prompt` Prompt: A prompt is a single question Pineprompt asks the AI platforms on your behalf. An active prompt runs with its monitor once per day; an inactive prompt keeps its history but no longer runs. - `id` integer: The unique ID of the prompt. - `monitor_id` integer: The ID of the monitor that owns this prompt. - `prompt` string: The question text the monitor asks each platform on every run. - `is_active` boolean: Whether the prompt will run on each daily run of its monitor. - `monitor` Monitor: A monitor is a configured daily run: a set of prompts bound to one or more AI platforms in a chosen country and language. While a monitor is active, Pineprompt runs it once per day on your behalf. - `id` integer: The unique ID of the monitor. - `project_id` integer: The ID of the project this monitor runs under. - `name` string: The display name of the monitor. - `platforms` string[]: The AI platforms the monitor runs against. - `country` string: The ISO 3166-1 alpha-2 country code. - `language` string: The language the monitor runs in. - `is_active` boolean: Whether the monitor will run on its next daily run. - `project` Project: A project represents a single brand or site you monitor. Its `brand_id` names the own brand, the brand every core metric is computed for. - `id` integer: The unique ID of the project. - `organization_id` integer: The ID of the organization that owns the project. - `name` string: The display name of the project. - `brand_id` integer, nullable: The ID of the project's own brand, or null while none has been designated. - `organization` Organization: An organization is the top-level billing entity and tenant boundary in Pineprompt. Every project, member, and API key belongs to exactly one organization. - `id` integer: The unique ID of the organization. - `name` string: The display name of the organization. - `created_at` string, date-time: When the organization was created. - `updated_at` string, date-time: When the organization was last updated. - `created_at` string, date-time: When the project was created. - `updated_at` string, date-time: When the project was last updated. - `created_at` string, date-time: When the monitor was created. - `updated_at` string, date-time: When the monitor was last updated. - `created_at` string, date-time: When the prompt was created. - `updated_at` string, date-time: When the prompt was last updated. - `monitor` Monitor: A monitor is a configured daily run: a set of prompts bound to one or more AI platforms in a chosen country and language. While a monitor is active, Pineprompt runs it once per day on your behalf. - `id` integer: The unique ID of the monitor. - `project_id` integer: The ID of the project this monitor runs under. - `name` string: The display name of the monitor. - `platforms` string[]: The AI platforms the monitor runs against. - `country` string: The ISO 3166-1 alpha-2 country code. - `language` string: The language the monitor runs in. - `is_active` boolean: Whether the monitor will run on its next daily run. - `project` Project: A project represents a single brand or site you monitor. Its `brand_id` names the own brand, the brand every core metric is computed for. - `id` integer: The unique ID of the project. - `organization_id` integer: The ID of the organization that owns the project. - `name` string: The display name of the project. - `brand_id` integer, nullable: The ID of the project's own brand, or null while none has been designated. - `organization` Organization: An organization is the top-level billing entity and tenant boundary in Pineprompt. Every project, member, and API key belongs to exactly one organization. - `id` integer: The unique ID of the organization. - `name` string: The display name of the organization. - `created_at` string, date-time: When the organization was created. - `updated_at` string, date-time: When the organization was last updated. - `created_at` string, date-time: When the project was created. - `updated_at` string, date-time: When the project was last updated. - `created_at` string, date-time: When the monitor was created. - `updated_at` string, date-time: When the monitor was last updated. - `project` Project: A project represents a single brand or site you monitor. Its `brand_id` names the own brand, the brand every core metric is computed for. - `id` integer: The unique ID of the project. - `organization_id` integer: The ID of the organization that owns the project. - `name` string: The display name of the project. - `brand_id` integer, nullable: The ID of the project's own brand, or null while none has been designated. - `organization` Organization: An organization is the top-level billing entity and tenant boundary in Pineprompt. Every project, member, and API key belongs to exactly one organization. - `id` integer: The unique ID of the organization. - `name` string: The display name of the organization. - `created_at` string, date-time: When the organization was created. - `updated_at` string, date-time: When the organization was last updated. - `created_at` string, date-time: When the project was created. - `updated_at` string, date-time: When the project was last updated. - `created_at` string, date-time: When the response was recorded. - `updated_at` string, date-time: When the response was last updated. - `brand` Brand: 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. - `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` 'own' | 'competitor' | 'discovered' | 'ignored': 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` string, date-time, nullable: When the brand was ignored, or null while it is not. Set and cleared through the `ignored` field on the update endpoint. - `project` Project: A project represents a single brand or site you monitor. Its `brand_id` names the own brand, the brand every core metric is computed for. - `id` integer: The unique ID of the project. - `organization_id` integer: The ID of the organization that owns the project. - `name` string: The display name of the project. - `brand_id` integer, nullable: The ID of the project's own brand, or null while none has been designated. - `organization` Organization: An organization is the top-level billing entity and tenant boundary in Pineprompt. Every project, member, and API key belongs to exactly one organization. - `id` integer: The unique ID of the organization. - `name` string: The display name of the organization. - `created_at` string, date-time: When the organization was created. - `updated_at` string, date-time: When the organization was last updated. - `created_at` string, date-time: When the project was created. - `updated_at` string, date-time: When the project was last updated. - `created_at` string, date-time: When the brand was created. - `updated_at` string, date-time: When the brand was last updated. - `created_at` string, date-time: When the brand mention was recorded. - `updated_at` string, date-time: When the brand mention was last updated. ## Other responses - `400`: Missing project header - `401`: Unauthorized - `403`: Missing ability - `404`: Not found - `422`: Validation failed --- [API](https://skmtc.dev/pineprompt/apis/pineprompt-api.md) · [All operations](https://skmtc.dev/pineprompt/apis/pineprompt-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pineprompt/apis/pineprompt-api/revisions/05dbb5241a27?raw)