Ads · Conversions

Get Event Match Quality

Fetches an Event Match Quality. Works with Meta Ads and Pinterest Ads.

GEThttps://api.pozy.ai/v1/ads/conversions/quality

Facebook and Instagram and PinterestgetConversionsQuality

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the ads resource group disabled get 403 resource_group_disabled. Authentication

Query parameters

Name	Type	Notes
`accountId`required	string
`destinationId`required	string

Example

curl -X GET "https://api.pozy.ai/v1/ads/conversions/quality?accountId=696e0b682d0a31188e7a2ba9&destinationId=68320031250f5d01a73ce89b" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/ads/conversions/quality?accountId=696e0b682d0a31188e7a2ba9&destinationId=68320031250f5d01a73ce89b", {
  headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.get(
    "https://api.pozy.ai/v1/ads/conversions/quality",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    params={
        "accountId": "696e0b682d0a31188e7a2ba9",
        "destinationId": "68320031250f5d01a73ce89b",
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

platformstring
rowsarray of object
- eventNamestring
- compositeScorenumber
- matchKeysarray of object
  2 child fields
  - identifierstring
  - coveragePercentagenumber
- eventCoveragePercentagenumber

200 response

{
  "platform": "instagram",
  "rows": [
    {
      "eventName": "Acme",
      "compositeScore": 12.5,
      "matchKeys": [
        {
          "identifier": "string",
          "coveragePercentage": 12.5
        }
      ],
      "eventCoveragePercentage": 12.5
    }
  ]
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is scoped to other profiles or has this resource group disabled.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.

Request

Query parameters

Example

Response

Errors

More in Conversions