Spytay

Документація API

Доступ лише для читання до звітів, які ви вже замовили: висновок, місце серед брендів, таблиці за асистентами, відповіді дослівно та план дій. Видимість, перше місце й інтервали — частки від 0 до 1. Ключ створюється в кабінеті, розділ «API». Версія 1.0.0, адреса: https://spytay.com/api/v1. Специфікація OpenAPI 3.1: /api/v1/openapi.json.

Ключ

Створіть ключ у кабінеті: Кабінет → API. Ми показуємо його лише один раз. Передавайте ключ у заголовку Authorization; cookie кабінету API не приймає.

curl -H "Authorization: Bearer $SPYTAY_API_KEY" "https://spytay.com/api/v1/me"

Помилки

Помилка завжди приходить як JSON із кодом англійською та поясненням українською:

{"error": {"code": "not_found", "message": "Звіт не знайдено."}}

Коди: unauthorized (401, є заголовок WWW-Authenticate: Bearer), not_found (404; чужий звіт теж 404), method_not_allowed (405), validation_error (422), rate_limited (429, є заголовок Retry-After), internal_error (500).

Ліміти

60 запитів за хвилину і 1000 за годину на ключ; кожен запит рахується. Невдалі спроби без чинного ключа — до 30 за хвилину з однієї адреси. Усі відповіді мають Cache-Control: no-store.

`GET /api/v1/me`

Поточний ключ і кабінет. Хто ви для API: номер кабінету, адреса, префікс ключа, ліміти та кількість звітів.

curl -H "Authorization: Bearer $SPYTAY_API_KEY" "https://spytay.com/api/v1/me"

{
  "customer_id": 12,
  "email": "name@example.com",
  "key_prefix": "spk_AbCdEf12",
  "reports_count": 3,
  "limits": {
    "per_minute": 60,
    "per_hour": 1000
  }
}

Коди відповіді: 200, 401, 404, 429.

`GET /api/v1/reports`

Список звітів. Звіти кабінету, найновіші перші: статус, категорія, бренд, асистенти, k і публічне посилання.

Параметр	Де	Тип	Опис
`limit`	запит	integer (≥ 1, ≤ 100, типово 50)	Скільки звітів повернути (до 100).
`offset`	запит	integer (≥ 0, ≤ 1000000, типово 0)	Скільки звітів пропустити.

curl -H "Authorization: Bearer $SPYTAY_API_KEY" "https://spytay.com/api/v1/reports"

{
  "reports": [
    {
      "id": 41,
      "status": "done",
      "created_at": "2026-10-12T09:00:00Z",
      "finished_at": "2026-10-12T09:20:00Z",
      "category": "сухий корм для котів",
      "focal_brand": "Мурка",
      "package": "report",
      "assistants": [
        {
          "id": "openai/gpt-5.5",
          "name": "ChatGPT"
        }
      ],
      "k": 5,
      "answers_total": 176,
      "report_url": "https://spytay.com/r/<token>"
    }
  ],
  "total": 1,
  "limit": 50,
  "offset": 0
}