Partner API-dokumentáció

401 INVALID_TOKEN

Egyetlen aktív token sem felel meg a Bearer hitelesítő adatnak, vagy a tokent visszavonták. A hiányzó vagy hibás formátumú Authorization fejlécre is 401-es válasz érkezik, de ezzel a kóddal csak a metrics végpont látja el. Partnervégponton használt SSP token esetén ugyanez a válasz érkezik.

{
  "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

A token érvényes, de a hozzá tartozó kiadó nem rendelkezik Pro csomaggal. A rendszer ezt a hatókör előtt ellenőrzi, így egy nem Pro csomagos kiadóhoz tartozó, csak olvasási jogú token esetén a hiba a csomagra utal, nem a hatókörre.

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

403 INSUFFICIENT_SCOPE

A token érvényes és Pro csomaghoz tartozik, de nem rendelkezik a mutatók jelentéséhez szükséges metrics:write hatókörrel.

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

403 FORBIDDEN

A közlemény egy másik kiadóhoz tartozik. Semmi nem kerül rögzítésre.

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

400 INVALID_METRICS

A kérés törzse nem érvényes JSON, vagy a két számérték hiányzik, negatív vagy nem egész szám. A válasz felsorolja, mi nem felelt meg.

{
  "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

A közlemény kívül esik azon a körön, amelyre az elköteleződési mutatók vonatkoznak. A II. melléklet 15. megjegyzése olyan online vagy natív közleményre terjed ki, amely célzott hirdetési technikákat vagy reklámeljuttatási technikákat alkalmazott, és amelynek megjelenítése már megkezdődött. Nem történik adatrögzítés.

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

404 NOT_FOUND

Ehhez a PA-ID-hoz nem tartozik közlemény, vagy az még nem látható az Ön számára. Mielőtt arra következtetne, hogy az azonosító hibás, olvassa el a fenti szakaszt.

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

{
  "error": "Advertisement not found"
}

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

429 RATE_LIMITED

Túllépte a tokenenkénti korlátot. A válasz tartalmazza az X-RateLimit-Limit, X-RateLimit-Remaining és X-RateLimit-Reset fejlécet.

{
  "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"
}

Géppel olvasható specifikáció

A teljes OpenAPI 3.1 dokumentum a /api/docs címen érhető el. Adja meg ezt közvetlenül a Postmanben, a Swagger UI-ban vagy egy kliensgenerátorban, ahelyett hogy ezt az oldalt másolná át.