Public API v1

Частотность

Передайте UUID и актуальные версии ключей, затем читайте состояние и постраничный результат.

GET/projects/{projectId}/frequency-collectionsfrequency:read POST/projects/{projectId}/frequency-collectionsfrequency:run GET/projects/{projectId}/frequency-collections/{jobId}frequency:read GET/projects/{projectId}/frequency-collections/{jobId}/resultfrequency:read POST/projects/{projectId}/frequency-collections/{jobId}/cancelfrequency:run POST/projects/{projectId}/frequency-collections/{jobId}/retry-failedfrequency:run

Создать съём

POST/projects/{projectId}/frequency-collectionsfrequency:run

Запросbash

curl -X POST "https://api.seonorita.ru/api/v1/projects/<projectId>/frequency-collections" \
  -H "Authorization: Bearer $SEO_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: frequency:agent:batch-42" \
  -d '{
    "items": [
      { "id": "<keywordId>", "version": 7 }
    ],
    "types": ["BASE", "EXACT", "FIXED"],
    "regionCode": "213",
    "device": "ALL"
  }'

202 · Ответjson

{
  "data": {
    "id": "<jobId>",
    "provider": "XMLSTOCK",
    "status": "QUEUED",
    "selectedKeywords": 1,
    "completedKeywords": 0,
    "failedKeywords": 0,
    "types": ["BASE", "EXACT", "FIXED"],
    "regionCode": "213",
    "device": "ALL",
    "version": 1,
    "createdAt": "2026-09-01T16:00:00.000Z",
    "updatedAt": "2026-09-01T16:00:00.000Z"
  },
  "meta": { "requestId": "01J...", "version": 1 }
}

Прочитать результат

Запросbash

curl "https://api.seonorita.ru/api/v1/projects/<projectId>/frequency-collections/<jobId>/result?limit=200" \
  -H "Authorization: Bearer $SEO_API_TOKEN"

200 · Сокращённый ответjson

{
  "data": {
    "collection": { "id": "<jobId>", "status": "COMPLETED" },
    "rows": [
      {
        "keywordId": "<keywordId>",
        "sequence": 1,
        "values": [
          { "type": "BASE", "value": "18420", "regionCode": "213" },
          { "type": "EXACT", "value": "870", "regionCode": "213" }
        ]
      }
    ],
    "page": { "hasNext": false }
  },
  "meta": { "requestId": "01J..." }
}