---
title: "Generate a shareable report"
method: POST
path: "/api/mcp/projects/{projectId}/reports"
tags: ["Reports"]
---

# Generate a shareable report

`POST /api/mcp/projects/{projectId}/reports`

Generate and publish a shareable report; returns { shareToken, shareUrl }. Set whiteLabel=true (requires a white-label-entitled plan) to apply workspace branding. Requires the `write` scope. Supports `Idempotency-Key` replay.

## Path parameters

- `projectId` string, uuid, required

## Headers

- `Idempotency-Key` string

## Request body

- ReportGenerateRequest
  - `reportType` 'sentiment' | 'visibility' | 'combined'
  - `timeRange` '7d' | '30d' | '90d' | '365d'
  - `platforms` string[]
  - `topicIds` string[]
  - `locationIds` string[]
  - `unbrandedOnly` boolean
  - `brandedOnly` boolean
  - `whiteLabel` boolean — Requires a white-label-entitled plan.
  - `title` string
  - `status` 'published' | 'draft'

## Response `200`

Report generated.

- ReportGenerateResponse
  - `shareToken` string, required
  - `shareUrl` string, uri, required
  - `reportType` 'sentiment' | 'visibility' | 'combined', required
  - `whiteLabel` boolean
  - `success` boolean, 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` — Another request with the same `Idempotency-Key` is still executing. `Retry-After` (5 seconds) is always present — retry with the SAME key once it elapses.
- `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.

---

[API](https://skmtc.net/searchable/apis/searchable-rest-api.md) · [All operations](https://skmtc.net/searchable/apis/searchable-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/searchable/searchable-rest-api/revisions/301b04e800ed/schema)