Ads · Conversions
Creates a website conversion action. Works with Google Ads.
https://api.pozy.ai/v1/ads/conversions/actionsGuide: Conversions API
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the ads resource group disabled get 403 resource_group_disabled. Authentication
Request body
application/json, required
accountIdstringrequiredadAccountIdstringcustomerIdstringdeprecatednamestringrequired1 to 100 characters.
typestringrequiredOne of
WEBPAGE.defaultValuenumberAt least 0.
alwaysUseDefaultValuebooleancategorystringOne of
DEFAULT,PAGE_VIEW,PURCHASE,SIGNUP,DOWNLOAD,ADD_TO_CART,BEGIN_CHECKOUT,SUBSCRIBE_PAID,PHONE_CALL_LEAD,IMPORTED_LEAD,SUBMIT_LEAD_FORM,BOOK_APPOINTMENT,REQUEST_QUOTE,GET_DIRECTIONS,OUTBOUND_CLICK,CONTACT,ENGAGEMENT,STORE_VISIT,STORE_SALE,QUALIFIED_LEAD,CONVERTED_LEAD.countingTypestringOne of
ONE_PER_CLICK,MANY_PER_CLICK.defaultCurrencystringMatches
^[A-Z]{3}$.clickThroughLookbackWindowDaysinteger1 to 90.
viewThroughLookbackWindowDaysinteger1 to 30.
primaryForGoalboolean
Example
curl -X POST "https://api.pozy.ai/v1/ads/conversions/actions" \
-H "Authorization: Bearer $POZY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"accountId": "696e0b682d0a31188e7a2ba9",
"name": "Acme",
"type": "WEBPAGE"
}'const res = await fetch("https://api.pozy.ai/v1/ads/conversions/actions", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.POZY_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
accountId: "696e0b682d0a31188e7a2ba9",
name: "Acme",
type: "WEBPAGE"
}),
});
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.post(
"https://api.pozy.ai/v1/ads/conversions/actions",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
json={
"accountId": "696e0b682d0a31188e7a2ba9",
"name": "Acme",
"type": "WEBPAGE",
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
201 on success
actionobject14 child fields
idstringrequirednamestringrequiredtypestringrequiredstatusstringrequiredcategorystringrequiredoriginstringprimaryForGoalbooleandefaultValuenumberdefaultCurrencystringalwaysUseDefaultValuebooleancountingTypestringclickThroughLookbackWindowDaysintegerviewThroughLookbackWindowDaysintegertagSnippetsarray of objectrequired4 child fields
typestringrequiredpageFormatstringglobalSiteTagstringeventSnippetstring
{
"action": {
"id": "6bfebd43ddc270f6d2c56fc5",
"name": "Acme",
"type": "string",
"status": "active",
"category": "string",
"origin": "string",
"primaryForGoal": true,
"defaultValue": 12.5,
"defaultCurrency": "string",
"alwaysUseDefaultValue": true,
"countingType": "string",
"clickThroughLookbackWindowDays": 1,
"viewThroughLookbackWindowDays": 1,
"tagSnippets": [
{
"type": "string",
"pageFormat": "string",
"globalSiteTag": "string",
"eventSnippet": "string"
}
]
}
}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 read-only, 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.