Ads · Ad Campaign Results
Name a result metric or define a formula.
PUT
https://api.pozy.ai/v1/ads/campaign-results/metrics/{key}Not available yetFacebook and Instagram, Google Workspace, TikTok, LinkedIn, Pinterest and X and 1 moresetCampaignResultMetric
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
This endpoint is not available yet. Calls return 403 feature_not_available.
Path parameters
| Name | Type | Notes |
|---|---|---|
keyrequired | string | Matches ^[a-z][a-z0-9_]{0,39}$ |
Request body
application/json, required
labelstringrequiredUp to 80 characters.
kindstringrequiredOne of
count,money,percent,ratio.currencystringCan be null.
formulastringUp to 200 characters. Can be null.
Example
curl -X PUT "https://api.pozy.ai/v1/ads/campaign-results/metrics/string" \
-H "Authorization: Bearer $POZY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"label": "string",
"kind": "count"
}'const res = await fetch("https://api.pozy.ai/v1/ads/campaign-results/metrics/string", {
method: "PUT",
headers: {
Authorization: `Bearer ${process.env.POZY_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
label: "string",
kind: "count"
}),
});
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.put(
"https://api.pozy.ai/v1/ads/campaign-results/metrics/string",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
json={
"label": "string",
"kind": "count",
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
metricobjectrequiredkeystringrequiredlabelstringrequiredkindstringrequiredOne of
count,money,percent,ratio.currencystringrequiredCan be null.
formulastringrequiredCan be null.
builtInbooleanrequired
200 response
{
"metric": {
"key": "string",
"label": "string",
"kind": "count",
"currency": "USD",
"formula": "string",
"builtIn": 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.