# Sumidata for AI agents

Sumidata is a product-analytics and session-replay SDK for websites. This file tells an
AI coding agent (Claude Code, Cursor, etc.) how to install Sumidata on a site and verify
the integration end-to-end through the Partner API — no dashboard required.

## Self-verifying install recipe

Full version: <https://sumidata.io/docs/install-with-ai-agent>

1. **Add the loader** to the `<head>` of every page:

   ```html
   <script>window.Sumidata=window.Sumidata||{push:function(m,a){(this.q=this.q||[]).push([m,a])}};</script>
   <script src="https://sdk.sumidata.io/loader.js" data-project-id="YOUR_PROJECT_ID" data-src="https://sdk.sumidata.io/sumidata.js" async></script>
   ```

2. **Deploy** the change.
3. **Get a Partner API token** (starts with `sumi_`) from Settings → API tokens.
4. **Confirm health** — poll until `"status":"healthy"`:

   ```bash
   curl -H "Authorization: Bearer <sumi_token>" https://api.sumidata.io/api/partner/health
   ```

5. **Confirm events** are landing:

   ```bash
   curl -H "Authorization: Bearer <sumi_token>" "https://api.sumidata.io/api/partner/events?perPage=5"
   ```

6. **Validate metadata** (expect `"valid": true`, empty `violations`):

   ```bash
   curl -H "Authorization: Bearer <sumi_token>" https://api.sumidata.io/api/partner/schema/validate
   ```

The integration is verified when `/api/partner/health` reports `healthy` and
`/api/partner/events` returns recent events.

## Partner API

All endpoints take `Authorization: Bearer sumi_<token>`.

| Endpoint | Purpose |
|----------|---------|
| `GET /api/partner/health` | Integration health: `healthy` / `warning` / `error` |
| `GET /api/partner/events` | Recent events (q-DSL filters) |
| `GET /api/partner/logs` | Recent logs (q-DSL filters) |
| `GET /api/partner/sessions` | Recent sessions; AI-agent filter: `?q[visitorKind__in]=ai_agent_declared,ai_agent_suspected` |
| `GET /api/partner/schema/validate` | Validate recent events against the metadata allowlist |

Full Partner API docs: <https://sumidata.io/docs/partner-api>
