Documentatie partner-API

401 INVALID_TOKEN

Geen actief token komt overeen met de Bearer-referentie, of het token is ingetrokken. Een ontbrekende of onjuiste Authorization-header levert eveneens 401 op, maar alleen het metrics-eindpunt voorziet die van deze code. Een SSP-token op een partnereindpunt krijgt hetzelfde antwoord.

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

Het token is geldig, maar de uitgever ervan heeft geen Pro-abonnement. Dit wordt vóór het toegangsniveau gecontroleerd, dus bij een alleen-lezentoken van een uitgever zonder Pro-abonnement wordt het abonnement gemeld en niet het toegangsniveau.

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

403 INSUFFICIENT_SCOPE

Het token is geldig en heeft Pro, maar mist het toegangsniveau metrics:write dat nodig is om cijfers te rapporteren.

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

403 FORBIDDEN

De transparantieverklaring hoort bij een andere uitgever. Er wordt niets weggeschreven.

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

400 INVALID_METRICS

De inhoud van het verzoek is geen geldige JSON, of de twee aantallen ontbreken, zijn negatief of zijn geen gehele getallen. De reactie vermeldt wat er niet klopte.

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

De transparantieverklaring valt buiten het toepassingsgebied waarvoor betrokkenheidscijfers zijn gedefinieerd. Bijlage II, noot 15, heeft betrekking op een transparantieverklaring voor een online of ingebedde politieke reclameboodschap waarvoor targetingtechnieken of technieken voor de aanlevering van een reclameboodschap zijn gebruikt en waarvan de verspreiding is begonnen. Er wordt niets weggeschreven.

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

404 NOT_FOUND

Geen enkele transparantieverklaring komt overeen met dat PA-ID, of zij is nog niet voor u zichtbaar. Lees het gedeelte hierboven voordat u aanneemt dat de identificatiecode onjuist is.

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

{
  "error": "Advertisement not found"
}

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

429 RATE_LIMITED

De limiet per token is overschreden. De reactie bevat X-RateLimit-Limit, X-RateLimit-Remaining en 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"
}

Machineleesbare specificatie

Het volledige OpenAPI 3.1-document is beschikbaar op /api/docs. Richt Postman, Swagger UI of een clientgenerator daar rechtstreeks op in plaats van deze pagina over te nemen.