v1

latestOpenAPI 3.0.02026-07-222980136.7 KB

Brand Reports

List prompts for a cited URL

get/v1/reports/brand/{reportId}/citations/prompts

Path parameters

reportIdstring required

Brand report identifier.

Example:01HX7K2YV9D3M8N0G6Q5R4S3T2

Brand report identifier.

Query parameters

urlstring required

Cited URL to fetch prompts for. URL-encoded.

Example:https://example.com/guides/best-flat-feet-running-shoes

Cited URL to fetch prompts for. URL-encoded.

startDatestring required

Start date for the lookup window (inclusive).

Example:2025-01-01

Start date for the lookup window (inclusive).

endDatestring required

End date for the lookup window (inclusive).

Example:2025-01-31

End date for the lookup window (inclusive).

countrystring required

Country code to filter by. Lowercase ISO 3166-1 alpha-2; use uk for the United Kingdom.

Example:us

Country code to filter by. Lowercase ISO 3166-1 alpha-2; use uk for the United Kingdom.

AI engine identifier.

string[]

Example:chatgpt

Optional. AI engine(s) to filter by. Repeat the param or pass a single value.

tagIdstring

Optional. Filter prompts by tag id.

Response

A list of prompts that cited the given URL.

Example response

{
  "items": [
    {
      "id": "01HXP1DRTM5G8Z2N3KQ7VAW4PA",
      "prompt": "best running shoes for flat feet",
      "engines": [
        "chatgpt",
        "perplexity"
      ],
      "brandMentioned": 1
    }
  ],
  "paging": {
    "limit": 1,
    "offset": 0
  }
}