Skip to main content
The API playground lets you try the API against your own data without leaving the dashboard — the fastest way to learn an endpoint’s parameters and response before you write any code. Pick an endpoint, fill in the parameters, run it, and copy a ready-made snippet.

What it’s for

  • See the real response shape for an endpoint, run against your own data. Response bodies aren’t documented in the reference yet, so this is the way to see what comes back.
  • Copy a snippet in the language you use — the playground generates the call for you.
  • Confirm your key works end to end before wiring the API into your app.
The catalog covers the complete customer-facing REST surface. Alongside site analytics and management, it includes:
  • Shortlinks — create, read, update, delete, and read click statistics.
  • Org Analytics — combined overview, time series, per-site time series, and live visitors.
  • Org Dashboards — list, create, read, update, delete, and run a card.
  • Stripe — connect, inspect, and disconnect a site’s revenue integration.
  • User writes and discovery — identify or delete a user, update traits, and discover autocaptured names and property values.
  • Additional operations — update a funnel, move a site, generate SQL with AI, read public tracking configuration and embed statistics, and manage your personal Anthropic key.
Each entry’s method, parameters, and example body follow the route’s validation schema. If a customer-facing route is added, it should be added to the playground or consciously excluded. To look up an endpoint’s path, method, and parameters without signing in, use the Endpoints section of this reference instead — it documents 133 endpoints across 29 groups.

Authentication

The generated snippets use an API key as Authorization: Bearer YOUR_API_KEY — the same credential you’ll use in production. Swap in a real key from your account settings to run a call.

Frequently asked questions

Yes. Org Analytics covers the organization overview, combined and per-site time series, and live visitors. Org Dashboards covers dashboard CRUD and running a SQL card across its permitted site scope.
Run the endpoint in the playground against your own data. The public endpoint reference documents paths, methods, and parameters, but response schemas are not available yet.

Analytics read API

The endpoints the playground runs.

API keys

Create the key the snippets need.

Scoped SQL query

Run raw SQL when reports aren’t enough.

API reference

Base URL, auth, and status codes.