---
title: "Get topic by platform position heatmap"
method: GET
path: "/api/mcp/projects/{projectId}/topics/heatmap"
tags: ["Topics"]
---

# Get topic by platform position heatmap

`GET /api/mcp/projects/{projectId}/topics/heatmap`

## Request

- Base URL: `https://app.searchable.com`
- URL: `https://app.searchable.com/api/mcp/projects/{projectId}/topics/heatmap`
- Auth: HTTP bearer

Average brand mention position per topic x AI platform — where the brand is strong on one engine and absent on another. There is deliberately no platform filter: the platform axis is the report.

## Path parameters

- `projectId` string, uuid, required

## Query parameters

- `topicId` string, uuid
- `days` integer
- `from` string
- `to` string
- `unbranded` 'true'
- `branded` 'true'

## Response `200`

Topic x platform position cells.

- TopicHeatmapResponse: Average brand position per topic x platform. The platform axis is the report, so it takes no platform filter.
  - `project` object, required
    - `id` string, required
    - `name` string, required
    - `domain` string, nullable, required
    - `brandName` string, required
  - `platforms` string[], required
  - `cells` object[], required
    - `topicId` string, required
    - `topicName` string, required
    - `platform` string, required
    - `avgPosition` number, required
    - `mentionCount` number, required
    - `responseCount` number, required
  - `dateRange` object, required
    - `from` string, date-time, required
    - `to` string, date-time, required

## Other responses

- `400`: Error response. `code` is the machine-readable reason — see the [error reference](/api/errors) for the full catalog and remediation per code.
- `401`: Error response. `code` is the machine-readable reason — see the [error reference](/api/errors) for the full catalog and remediation per code.
- `403`: Error response. `code` is the machine-readable reason — see the [error reference](/api/errors) for the full catalog and remediation per code.
- `404`: Error response. `code` is the machine-readable reason — see the [error reference](/api/errors) for the full catalog and remediation per code.
- `409`: Error response. `code` is the machine-readable reason — see the [error reference](/api/errors) for the full catalog and remediation per code.
- `429`: Rate limited. Usually the per-API-key REST limit (600 requests/minute); on Google-backed endpoints it can also relay an upstream Google rate limit. `Retry-After` (seconds) is present when the limit was applied by Searchable's own rate limiter; it may be absent when an upstream provider rate-limits.
- `504`: Error response. `code` is the machine-readable reason — see the [error reference](/api/errors) for the full catalog and remediation per code.

## Changes

- **2026-11-03** `28a5e2a65cd3`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/searchable/apis/searchable-rest-api/changes/api/mcp/projects/:projectId/topics/heatmap/get.md)

---

[API](https://skmtc.dev/searchable/apis/searchable-rest-api.md) - [All operations](https://skmtc.dev/searchable/apis/searchable-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/searchable/apis/searchable-rest-api/revisions/a1cc70e46e73?raw)
