Ads · Conversions

Get a conversion destination

Fetches a conversion destination. Works with LinkedIn Ads.

GEThttps://api.pozy.ai/v1/accounts/{accountId}/conversion-destinations/{destinationId}

LinkedIngetConversionDestination

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
`accountId`required	string
`destinationId`required	string

Query parameters

Name	Type	Notes
`adAccountId`required	string

Example

curl -X GET "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/conversion-destinations/68320031250f5d01a73ce89b?adAccountId=666219aad7bab67ace411e4f" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/conversion-destinations/68320031250f5d01a73ce89b?adAccountId=666219aad7bab67ace411e4f", {
  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/68320031250f5d01a73ce89b",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    params={
        "adAccountId": "666219aad7bab67ace411e4f",
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

platformstring
One of linkedinads.
destinationobject
- idstringrequired
- namestringrequired
- typestring
- statusstring
  One of active, inactive.
- adAccountIdstring

200 response

{
  "platform": "linkedinads",
  "destination": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme",
    "type": "string",
    "status": "active",
    "adAccountId": "666219aad7bab67ace411e4f"
  }
}

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.