Sign in

v1

latestOpenAPI 3.0.02026-07-222980136.7 KB
Brand Reports

Get prompt details from a brand report.

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

Path parameters

reportIdstring required

Brand report identifier.

Example:01HX7K2YV9D3M8N0G6Q5R4S3T2

Brand report identifier.

promptIdstring required

Prompt identifier within the brand report.

Example:01HX7K2YV9D3M8N0G6Q5R4S3T2

Prompt identifier within the brand report.

Query parameters

startDatestring required

Start date for the lookup window (inclusive). Accepts YYYY-MM-DD or a full ISO timestamp; only the date portion is used and the window is anchored at 00:00:00.000Z.

Example:2025-01-01

Start date for the lookup window (inclusive). Accepts YYYY-MM-DD or a full ISO timestamp; only the date portion is used and the window is anchored at 00:00:00.000Z.

endDatestring required

End date for the lookup window (inclusive). Accepts YYYY-MM-DD or a full ISO timestamp; only the date portion is used and the window is anchored at 23:59:59.999Z.

Example:2025-01-31

End date for the lookup window (inclusive). Accepts YYYY-MM-DD or a full ISO timestamp; only the date portion is used and the window is anchored at 23:59:59.999Z.

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.

Response

Details for the prompt within the brand report.

idstring required
reportIdstring required
promptstring required
intentVolumenumber required

Example response

{
  "id": "01HXP1DRTM5G8Z2N3KQ7VAW4PA",
  "reportId": "01HXBR1DGM5XY8Z2N3KQ7VAW4P",
  "prompt": "best running shoes 2025",
  "intentVolume": 12500,
  "brandCoverageHistory": [
    {
      "brand": "Adidas",
      "coverage": 0.42,
      "date": "2025-01-15"
    }
  ],
  "brandRank": [
    {
      "brand": "Adidas",
      "rank": 1,
      "mentions": 1705,
      "brandCoverage": 0.42,
      "sentiment": {
        "positive": 0.6,
        "neutral": 0.3,
        "negative": 0.1,
        "nss": 0.5
      }
    }
  ],
  "domainCategories": [
    {
      "category": "News/Media",
      "value": 18
    },
    {
      "category": "Brand",
      "value": 7
    }
  ],
  "brandReports": [
    {
      "id": "01HXBR1DGM5XY8Z2N3KQ7VAW4P",
      "brand": "Adidas",
      "brandDomain": "adidas.com",
      "reportTitle": "Adidas Visibility Report"
    }
  ],
  "tags": [
    {
      "id": "01HX8AB3CDE4FG5HJ6KL7MN8PQ",
      "name": "Running Shoes",
      "color": "orange"
    }
  ]
}