brand-mentions

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}

Request

  • Base URL: https://pineprompt.com
  • URL: https://pineprompt.com/api/v1/brand-mentions/{brandMention}
  • Auth: HTTP bearer

Path parameters

brandMentioninteger required
Example:91234

The numeric ID of the brand mention.

Query parameters

includestring
Example:brand

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.

Headers

Pineprompt-Project-Idinteger required

The active project's numeric ID.

Response

OK

idinteger

The unique ID of the brand mention.

response_idinteger

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_idinteger

The numeric ID of the brand that was mentioned. You may pass this ID to the brand_id filter on the list endpoint.

positioninteger

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

sentiment_scoreinteger

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

created_atstring date-time

When the brand mention was recorded.

updated_atstring date-time

When the brand mention was last updated.

Example response

{
  "id": 91234,
  "response_id": 7842,
  "brand_id": 555,
  "position": 1,
  "sentiment_score": 72,
  "response": {
    "id": 7842,
    "prompt_id": 901,
    "monitor_id": 271,
    "prompt_text": "What are the best AI visibility monitoring tools?",
    "platform": "chatgpt",
    "model": "gpt-4",
    "country": "US",
    "language": "en",
    "prompt": {
      "id": 901,
      "monitor_id": 271,
      "prompt": "What are the best AI visibility monitoring tools?",
      "is_active": true,
      "monitor": {
        "id": 271,
        "project_id": 42,
        "name": "Brand visibility (US)",
        "platforms": [
          "chatgpt",
          "perplexity",
          "claude"
        ],
        "country": "US",
        "language": "en",
        "is_active": true,
        "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"
      },
      "created_at": "2026-05-15T09:11:42+00:00",
      "updated_at": "2026-05-15T09:11:42+00:00"
    },
    "monitor": {
      "id": 271,
      "project_id": 42,
      "name": "Brand visibility (US)",
      "platforms": [
        "chatgpt",
        "perplexity",
        "claude"
      ],
      "country": "US",
      "language": "en",
      "is_active": true,
      "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"
    },
    "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"
  },
  "brand": {
    "id": 555,
    "project_id": 42,
    "display_name": "Acme Inc.",
    "aliases": [
      "Acme",
      "Acme Co"
    ],
    "domains": [
      "acme.com",
      "acme.co"
    ],
    "kind": "competitor",
    "color": "#008FFB",
    "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"
  },
  "created_at": "2026-05-15T09:11:42+00:00",
  "updated_at": "2026-05-15T09:11:42+00:00"
}

Changes

No recorded changes to this operation across all 1 revision of this API.