Ads · Conversions
Returns conversion destinations.
GET
https://api.pozy.ai/v1/accounts/{accountId}/conversion-destinationsFacebook and Instagram, Google Workspace, TikTok, LinkedIn, Pinterest and RedditlistConversionDestinations
Guides: Reddit Ads, ChatGPT Ads, Conversions API
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
Path parameters
| Name | Type | Notes |
|---|---|---|
accountIdrequired | string |
Example
curl -X GET "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/conversion-destinations" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/conversion-destinations", {
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/accounts/696e0b682d0a31188e7a2ba9/conversion-destinations",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
platformstringOne of
metaads,googleads,linkedinads,tiktokads,openaiads,pinterestads,redditads.destinationsarray of objectidstringnamestringtypestringstatusstringOne of
active,inactive.adAccountIdstringconversionEventsarray of object6 child fields
idstringnamestringeventTypestringCan be null.
customEventNamestringCan be null.
archivedbooleanoptimizableboolean
200 response
{
"platform": "metaads",
"destinations": [
{
"id": "6bfebd43ddc270f6d2c56fc5",
"name": "Acme",
"type": "string",
"status": "active",
"adAccountId": "666219aad7bab67ace411e4f",
"conversionEvents": [
{
"id": "6bfebd43ddc270f6d2c56fc5",
"name": "Acme",
"eventType": "string",
"customEventName": "Acme",
"archived": true,
"optimizable": true
}
]
}
]
}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. |
| 404 | not_found | Nothing with that id exists in your workspace. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.
More in Conversions
GETGet Event Match QualityPOSTSend conversion eventsPOSTAdjust uploaded conversionsGETList conversion actionsPOSTCreate website conversion actionGETList account conversion goalsPATCHUpdate account conversion goalsPATCHUpdate a conversion action's settingsGETList custom conversion goalsPOSTCreate a custom conversion goalPATCHUpdate a custom conversion goalDELRemove a custom conversion goalGETList stored eventsPOSTSend events to every destinationGETList event destinationsPOSTAdd an event destinationDELRemove an event destinationPOSTCreate a conversion destinationGETGet a conversion destinationPATCHUpdate a conversion destinationDELDelete a conversion destinationGETList associated campaignsPOSTAssociate campaignsDELRemove associated campaignsGETGet attribution metrics