brand-mentions

List brand mentions

Returns every brand mention detected across the active project. The response is paginated, with the newest mentions returned first by default.

get/api/v1/brand-mentions

Request

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

Query parameters

pageinteger
Example:1

The page number to return. Defaults to 1.

per_pageinteger
Example:25

The number of items per page. Defaults to 25, maximum 100.

response_idinteger
Example:7842

Limit results to mentions on a single response.

brand_idinteger
Example:555

Limit results to mentions of a single brand.

sort_by'created_at' | 'updated_at' | 'position' | 'sentiment_score'

The column to sort by. Defaults to created_at.

sort_order'asc' | 'desc'

The direction to sort by. Each endpoint has its own default.

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

Example response

{
  "data": [
    {
      "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"
    }
  ],
  "links": {
    "first": "https://pineprompt.com/api/v1/monitors?page=1",
    "last": "https://pineprompt.com/api/v1/monitors?page=1"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://pineprompt.com/api/v1/monitors",
    "per_page": 25,
    "to": 1,
    "total": 1,
    "links": [
      {
        "url": "https://pineprompt.com/api/v1/monitors?page=2",
        "label": "2",
        "page": 2
      }
    ]
  }
}

Changes

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