SEsearchable
Reports

Generate a shareable report

Changed on

Generate and publish a shareable report; returns { shareToken, shareUrl }. Set whiteLabel=true (requires a white-label-entitled plan) to apply workspace branding. Requires the read scope, as sharing a report is open to every project member in the app; the workspace's report sharing policy and a plan with report sharing still apply. Supports Idempotency-Key replay.

post/api/mcp/projects/{projectId}/reports

Request

  • Base URL
    https://app.searchable.com
  • Auth
    HTTP bearer

Path parameters

projectIdstring uuid required

The project id.

Headers

Idempotency-Keystring

Optional client-generated key (e.g. a UUID). Retrying with the same key within 24h replays the original stored response (X-Idempotent-Replay: true) instead of repeating the side effect. See Idempotency.

Request body

reportType'sentiment' | 'visibility' | 'combined'
timeRange'7d' | '30d' | '90d' | '365d'
platformsstring[]
topicIdsstring[]
locationIdsstring[]
unbrandedOnlyboolean
brandedOnlyboolean
whiteLabelboolean

Requires a white-label-entitled plan.

titlestring
status'published' | 'draft'

Response

Report generated.

shareTokenstring required
shareUrlstring uri required
reportType'sentiment' | 'visibility' | 'combined' required
whiteLabelboolean
successboolean required

Changes

  • 28a5e2a65cd3Revision changes
    • warning

      added the new duplicate_scope enum value to the response property for the response status

    • warning

      added the new duplicate_scope enum value to the response property for the response status

    • warning

      added the new duplicate_scope enum value to the response property for the response status

    • warning

      added the new duplicate_scope enum value to the response property for the response status

    • warning

      added the new duplicate_scope enum value to the response property for the response status

    • warning

      added the new duplicate_scope enum value to the response property for the response status

    • warning

      added the new duplicate_scope enum value to the response property for the response status

    • warning

      added the new host_outside_domain enum value to the response property for the response status

    • warning

      added the new host_outside_domain enum value to the response property for the response status

    • warning

      added the new host_outside_domain enum value to the response property for the response status

    • warning

      added the new host_outside_domain enum value to the response property for the response status

    • warning

      added the new host_outside_domain enum value to the response property for the response status

    • warning

      added the new host_outside_domain enum value to the response property for the response status

    • warning

      added the new host_outside_domain enum value to the response property for the response status

    • warning

      added the new idempotency_conflict enum value to the response property for the response status

    • warning

      added the new idempotency_conflict enum value to the response property for the response status

    • warning

      added the new idempotency_conflict enum value to the response property for the response status

    • warning

      added the new idempotency_conflict enum value to the response property for the response status

    • warning

      added the new idempotency_conflict enum value to the response property for the response status

    • warning

      added the new idempotency_conflict enum value to the response property for the response status

    • warning

      added the new idempotency_conflict enum value to the response property for the response status

    • warning

      added the new invalid_citation_type enum value to the response property for the response status

    • warning

      added the new invalid_citation_type enum value to the response property for the response status

    • warning

      added the new invalid_citation_type enum value to the response property for the response status

    • warning

      added the new invalid_citation_type enum value to the response property for the response status

    • warning

      added the new invalid_citation_type enum value to the response property for the response status

    • warning

      added the new invalid_citation_type enum value to the response property for the response status

    • warning

      added the new invalid_citation_type enum value to the response property for the response status

    • warning

      added the new invalid_scope enum value to the response property for the response status

    • warning

      added the new invalid_scope enum value to the response property for the response status

    • warning

      added the new invalid_scope enum value to the response property for the response status

    • warning

      added the new invalid_scope enum value to the response property for the response status

    • warning

      added the new invalid_scope enum value to the response property for the response status

    • warning

      added the new invalid_scope enum value to the response property for the response status

    • warning

      added the new invalid_scope enum value to the response property for the response status

    • warning

      added the new missing_competitor enum value to the response property for the response status

    • warning

      added the new missing_competitor enum value to the response property for the response status

    • warning

      added the new missing_competitor enum value to the response property for the response status

    • warning

      added the new missing_competitor enum value to the response property for the response status

    • warning

      added the new missing_competitor enum value to the response property for the response status

    • warning

      added the new missing_competitor enum value to the response property for the response status

    • warning

      added the new missing_competitor enum value to the response property for the response status

    • warning

      added the new rule_limit enum value to the response property for the response status

    • warning

      added the new rule_limit enum value to the response property for the response status

    • warning

      added the new rule_limit enum value to the response property for the response status

    • warning

      added the new rule_limit enum value to the response property for the response status

    • warning

      added the new rule_limit enum value to the response property for the response status

    • warning

      added the new rule_limit enum value to the response property for the response status

    • warning

      added the new rule_limit enum value to the response property for the response status

    • warning

      added the new security_policy_denied enum value to the response property for the response status

    • warning

      added the new security_policy_denied enum value to the response property for the response status

    • warning

      added the new security_policy_denied enum value to the response property for the response status

    • warning

      added the new security_policy_denied enum value to the response property for the response status

    • warning

      added the new security_policy_denied enum value to the response property for the response status

    • warning

      added the new security_policy_denied enum value to the response property for the response status

    • warning

      added the new security_policy_denied enum value to the response property for the response status

    • warning

      added the new unknown_competitor enum value to the response property for the response status

    • warning

      added the new unknown_competitor enum value to the response property for the response status

    • warning

      added the new unknown_competitor enum value to the response property for the response status

    • warning

      added the new unknown_competitor enum value to the response property for the response status

    • warning

      added the new unknown_competitor enum value to the response property for the response status

    • warning

      added the new unknown_competitor enum value to the response property for the response status

    • warning

      added the new unknown_competitor enum value to the response property for the response status