Get a brand mention

Returns a single brand mention. The mention must belong to a response in the active project.

GET /api/v1/brand-mentions/{brandMention}

Path parameters

Name	Type	Required	Description
brandMention	integer	Required	The numeric ID of the brand mention.

Query parameters

Name	Type	Required	Description
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

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.

import os import requests response = requests.get( "https://pineprompt.com/api/v1/brand-mentions/91234", headers={ "Authorization": f"Bearer {os.environ['PINEPROMPT_TOKEN']}", "Pineprompt-Project-Id": "1", }, ) response.raise_for_status() payload = response.json()

use GuzzleHttp\Client; $response = (new Client())->get('https://pineprompt.com/api/v1/brand-mentions/91234', [ 'headers' => [ 'Authorization' => 'Bearer '.getenv('PINEPROMPT_TOKEN'), 'Pineprompt-Project-Id' => '1', ], ]); // Guzzle throws on 4xx/5xx by default, so no manual check needed. $payload = json_decode((string) $response->getBody(), true);