> ## Documentation Index
> Fetch the complete documentation index at: https://tinyanalytics.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# tinyanalytics API Playground

> Try the tinyanalytics API against your own data from inside the dashboard — pick an endpoint, set parameters, run it, and copy a ready-to-use code snippet.

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](/docs/api-reference/api-authentication) 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.

<CodeGroup>
  ```bash cURL theme={null}
  curl "https://dash.tinyanalytics.io/api/sites/1/overview?start_date=2026-07-01&end_date=2026-07-15" \
    -H "Authorization: Bearer YOUR_API_KEY"
  ```

  ```js JavaScript theme={null}
  await fetch(
    "https://dash.tinyanalytics.io/api/sites/1/overview?start_date=2026-07-01&end_date=2026-07-15",
    {
      headers: { Authorization: "Bearer YOUR_API_KEY" },
    },
  )
  ```

  ```python Python theme={null}
  import requests

  requests.get(
      "https://dash.tinyanalytics.io/api/sites/1/overview",
      params={"start_date": "2026-07-01", "end_date": "2026-07-15"},
      headers={"Authorization": "Bearer YOUR_API_KEY"},
  )
  ```
</CodeGroup>

## Frequently asked questions

<AccordionGroup>
  <Accordion title="Does the playground include organization-level endpoints?">
    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.
  </Accordion>

  <Accordion title="Can I test shortlink and Stripe endpoints?">
    Yes. The **Shortlinks** category covers CRUD and click statistics. The **Revenue** category includes connecting Stripe, checking connection health, and disconnecting it.
  </Accordion>

  <Accordion title="Where do I see an endpoint's response body?">
    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.
  </Accordion>
</AccordionGroup>

## Related

<Columns cols={2}>
  <Card title="Analytics read API" icon="chart-line" href="/docs/api-reference/analytics-read-api">
    The endpoints the playground runs.
  </Card>

  <Card title="API keys" icon="key" href="/docs/api-reference/api-authentication">
    Create the key the snippets need.
  </Card>

  <Card title="Scoped SQL query" icon="database" href="/docs/api-reference/sql-analytics-api">
    Run raw SQL when reports aren't enough.
  </Card>

  <Card title="API reference" icon="book-open" href="/docs/api-reference/tinyanalytics-api">
    Base URL, auth, and status codes.
  </Card>
</Columns>


## Related topics

- [tinyanalytics API Reference](/docs/api-reference/tinyanalytics-api.md)
- [Analytics Read API](/docs/api-reference/analytics-read-api.md)
- [tinyanalytics Account Settings](/docs/tinyanalytics-account-settings.md)