Ads · Ad Rules
Returns ready-made ad rules.
https://api.pozy.ai/v1/ads/rules/templatesGuide: Automated ad rules
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
Example
curl -X GET "https://api.pozy.ai/v1/ads/rules/templates" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/ads/rules/templates", {
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/rules/templates",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
templatesarray of objectrequired9 child fields
idstringrequirednamestringrequireddescriptionstringrequiredlevelstringrequiredOne of
campaign,adset,ad.conditionsobjectrequired1 child field
allarray of objectrequiredAt least 1 item. Up to 10 items.
4 child fields
metricstringrequiredOne of
spend,impressions,clicks,conversions,ctr,cpc,cpm,cpa,roas,reach,frequency.windowstringrequiredOne of
today,yesterday,last_3d,last_7d,last_14d,last_30d.opstringrequiredOne of
>,>=,<,<=.valuenumberrequiredAt least 0.
actionsarray of objectrequiredAt least 1 item.
One of:
Option 1 (1 fields)
typestringrequiredOne of
notify.
Option 2 (2 fields)
typestringrequiredOne of
pause.maxChangesPerDayinteger1 to 100.
Option 3 (2 fields)
typestringrequiredOne of
activate.maxChangesPerDayinteger1 to 100.
Option 4 (5 fields)
typestringrequiredOne of
adjust_budget.directionstringrequiredOne of
increase,decrease.percentintegerrequired1 to 100.
limitnumberrequiredmaxChangesPerDayinteger1 to 100.
scheduleobjectrequired1 child field
everyMinutesintegerrequiredOne of
60,180,360,720,1440.
cooldownMinutesintegerrequiredplatformsarray of stringrequiredCan be null.
{
"templates": [
{
"id": "6bfebd43ddc270f6d2c56fc5",
"name": "Acme",
"description": "A short description",
"level": "campaign",
"conditions": {
"all": [
{
"metric": "spend",
"window": "today",
"op": ">",
"value": 12.5
}
]
},
"actions": [
{
"type": "notify"
}
],
"schedule": {
"everyMinutes": 60
},
"cooldownMinutes": 1,
"platforms": [
"instagram"
]
}
]
}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.