Skip to main content

API overview

Preview

The GTM Clarity REST API is in active development. The base URL and endpoints below are illustrative and may change before general availability. Want early access? Email hello@gtmclarity.ai.

The GTM Clarity REST API lets you read conversations, look up resolved visitors, and send events.

Base URL: https://api.gtmclarity.ai/v1

Authentication​

Use a secret API key (Settings → API keys) as a bearer token. Never expose it in client-side code — the widget uses your public site key instead.

curl https://api.gtmclarity.ai/v1/conversations \
  -H "Authorization: Bearer $GTMC_API_KEY"

Conventions​

  • JSON request and response bodies.
  • Cursor pagination via ?limit= and ?starting_after=.
  • Standard HTTP status codes; errors return { "error": { "code", "message" } }.

See Conversations, Visitors, and Events & webhooks.