Dokumentacja API dla partnerów

401 INVALID_TOKEN

Żaden aktywny token nie odpowiada poświadczeniu Bearer albo token został unieważniony. Brak nagłówka Authorization lub jego nieprawidłowy format również skutkuje odpowiedzią 401, ale tylko punkt końcowy metrics oznacza ją tym kodem. Token SSP użyty w punkcie końcowym partnera otrzymuje taką samą odpowiedź.

{
  "error": "Invalid or revoked partner API token. This endpoint only accepts partner tokens, not SSP tokens.",
  "code": "INVALID_TOKEN"
}

{
  "error": "Invalid or revoked partner API token.",
  "code": "INVALID_TOKEN"
}

{
  "error": "Missing or invalid Authorization header. Expected: Bearer <token>",
  "code": "INVALID_TOKEN"
}

{
  "error": "Missing or invalid Authorization header. Expected: Bearer <token>"
}

403 PRO_PLAN_REQUIRED

Token jest ważny, ale jego wydawca nie korzysta z planu Pro. Plan jest sprawdzany przed zakresem, dlatego token tylko do odczytu należący do wydawcy bez planu Pro zwraca błąd planu, a nie zakresu.

{
  "error": "The Pro plan is required to use the partner API.",
  "code": "PRO_PLAN_REQUIRED"
}

403 INSUFFICIENT_SCOPE

Token jest ważny i objęty planem Pro, ale brakuje mu zakresu metrics:write wymaganego do zgłaszania wskaźników.

{
  "error": "This token is not authorised to write metrics. Required scope: metrics:write.",
  "code": "INSUFFICIENT_SCOPE"
}

403 FORBIDDEN

Ogłoszenie należy do innego wydawcy. Nic nie zostaje zapisane.

{
  "error": "This advertisement belongs to a different publisher.",
  "code": "FORBIDDEN"
}

400 INVALID_METRICS

Treść żądania nie jest poprawnym dokumentem JSON albo brakuje dwóch wartości liczbowych, są one ujemne lub nie są liczbami całkowitymi. Odpowiedź wskazuje, które warunki nie zostały spełnione.

{
  "error": "Invalid engagement metrics",
  "code": "INVALID_METRICS",
  "issues": [
    {
      "path": "viewsCount",
      "message": "Too small: expected number to be >=0"
    }
  ]
}

{
  "error": "Invalid request body",
  "code": "INVALID_METRICS"
}

409 METRICS_NOT_APPLICABLE

Ogłoszenie wykracza poza zakres, dla którego określono wskaźniki zaangażowania. Przypis 15 do załącznika II obejmuje ogłoszenie dotyczące reklamy online lub natywnej, w której zastosowano techniki targetowania lub techniki dostarczania reklamy i której emisja już się rozpoczęła. Nic nie zostaje zapisane.

{
  "error": "Engagement metrics do not apply to this notice",
  "code": "METRICS_NOT_APPLICABLE"
}

404 NOT_FOUND

Żadne ogłoszenie nie odpowiada temu PA-ID albo nie jest ono jeszcze dla Ciebie widoczne. Zanim uznasz, że identyfikator jest błędny, zapoznaj się z sekcją powyżej.

{
  "error": "Advertisement not found",
  "code": "NOT_FOUND"
}

{
  "error": "Advertisement not found"
}

{
  "error": "Advertisement not found or not yet confirmed"
}

429 RATE_LIMITED

Przekroczono limit dla tokenu. Ta odpowiedź zawiera nagłówki X-RateLimit-Limit, X-RateLimit-Remaining i X-RateLimit-Reset.

{
  "error": "Rate limit exceeded",
  "code": "RATE_LIMITED",
  "limit": 1000,
  "remaining": 0,
  "reset": "2026-05-14T15:14:00.000Z"
}

{
  "error": "Rate limit exceeded",
  "limit": 1000,
  "remaining": 0,
  "reset": "2026-05-14T15:14:00.000Z"
}

Specyfikacja odczytywalna maszynowo

Pełny dokument OpenAPI 3.1 jest dostępny pod adresem /api/docs. Zamiast przepisywać tę stronę, wskaż go bezpośrednio w narzędziu Postman, Swagger UI lub w generatorze klienta.