Ads · Ad Targeting
Searches targeting options.
GET
https://api.pozy.ai/v1/ads/targeting/searchFacebook and Instagram, Google Workspace, TikTok, LinkedIn, Pinterest and RedditsearchAdTargeting
Guides: Ads, LinkedIn Ads, X Ads
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
Query parameters
| Name | Type | Notes |
|---|---|---|
accountIdrequired | string | |
qrequired | string | |
dimension | string | One of geo, interest, interestSuggestion, interestKeyword, behavior, hashtag, income, language, workPosition, workEmployer, workIndustry, industry, jobFunction, seniority, companySize, skill, community, conversationKeywordDefault interest |
geoType | string | One of all, country, country_group, region, city, subcity, neighborhood, place, zip, metro_area, geo_marketDefault city |
countryCode | string | Up to 2 characters |
adAccountId | string | |
locale | string | Matches ^[a-z]{2,3}_[A-Z]{2}$ |
limit | integer | Default 251 to 100 |
Example
curl -X GET "https://api.pozy.ai/v1/ads/targeting/search?accountId=696e0b682d0a31188e7a2ba9&q=string&limit=25" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/ads/targeting/search?accountId=696e0b682d0a31188e7a2ba9&q=string&limit=25", {
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/targeting/search",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
params={
"accountId": "696e0b682d0a31188e7a2ba9",
"q": "string",
"limit": 25,
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
resultsarray of object8 child fields
idstringrequirednamestringrequiredtypestringrequiredpatharray of stringaudienceSizeintegerCan be null.
statusstringcountryCodestringplatformIdstring
200 response
{
"results": [
{
"id": "6bfebd43ddc270f6d2c56fc5",
"name": "Acme",
"type": "string",
"path": [
"string"
],
"audienceSize": 1,
"status": "active",
"countryCode": "US",
"platformId": "648aa9da2e1bf42f668d6ef0"
}
]
}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.