Ads · Ad Rules
Previews an ad rule without changing anything.
POST
https://api.pozy.ai/v1/ads/rules/{ruleId}/previewFacebook and Instagram, Google Workspace, TikTok, LinkedIn, Pinterest and X and 1 morepreviewAdRule
Guide: Automated ad rules
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
Path parameters
| Name | Type | Notes |
|---|---|---|
ruleIdrequired | string |
Example
curl -X POST "https://api.pozy.ai/v1/ads/rules/6cd4059483de62b474d02fe7/preview" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/ads/rules/6cd4059483de62b474d02fe7/preview", {
method: "POST",
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.post(
"https://api.pozy.ai/v1/ads/rules/6cd4059483de62b474d02fe7/preview",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
evaluatedAtstring (date-time)requiredtodaystring (date)requiredtimezonestringrequiredtimezoneAssumedbooleanrequiredcurrencystringrequiredCan be null.
matchedintegerrequiredobjectsarray of objectrequiredidstringrequirednamestringrequiredcampaignIdstringrequiredCan be null.
matchedbooleanrequiredconditionsarray of objectrequired6 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.
actualnumberrequiredCan be null.
metbooleanrequired
200 response
{
"evaluatedAt": "2026-10-02T09:00:00.000Z",
"today": "2026-10-01",
"timezone": "America/New_York",
"timezoneAssumed": true,
"currency": "USD",
"matched": 1,
"objects": [
{
"id": "6bfebd43ddc270f6d2c56fc5",
"name": "Acme",
"campaignId": "65a3737dd8b11ea61f199e6e",
"matched": true,
"conditions": [
{
"metric": "spend",
"window": "today",
"op": ">",
"value": 12.5,
"actual": 12.5,
"met": 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 read-only, 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.