Ads · Ad Targeting

Forecast ad delivery

Forecasts an ad delivery without changing anything. Works with LinkedIn Ads.

POSThttps://api.pozy.ai/v1/ads/targeting/supply-forecast

LinkedIngetLinkedInSupplyForecast

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

accountIdstringrequired
adAccountIdstringrequired
specobjectrequired
31 child fields
- userOsarray of string
  At least 1 item.
- userDevicearray of string
  At least 1 item.
- countriesarray of string
- regionsarray of string or object
  One of:
  string
  Option 2 (2 fields)
  keystringrequired
  namestring
- citiesarray of string or object
  One of:
  string
  Option 2 (4 fields)
  keystringrequired
  namestring
  radiusnumber
  distanceUnitstring
  One of mile, kilometer.
- zipsarray of object
  2 child fields
  keystringrequired
  namestring
- metrosarray of object
  2 child fields
  keystringrequired
  namestring
- countryGroupsarray of string
  Each item: one of africa, asia, europe, north_america, south_america, oceania, central_america, caribbean, eea, euro_area, nafta, mercosur, afta, apec, gcc, cisfta, emerging_markets, itunes_app_store, android_free_store, android_paid_store.
- customLocationsarray of object
  6 child fields
  latitudenumberrequired
  -90 to 90.
  longitudenumberrequired
  -180 to 180.
  radiusnumberrequired
  distanceUnitstringrequired
  One of mile, kilometer.
  namestring
  addressstring
- excludedLocationsobject
  8 child fields
  countriesarray of string
  countryGroupsarray of string
  Each item: one of africa, asia, europe, north_america, south_america, oceania, central_america, caribbean, eea, euro_area, nafta, mercosur, afta, apec, gcc, cisfta, emerging_markets, itunes_app_store, android_free_store, android_paid_store.
  regionsarray of object
  2 child fields
  keystringrequired
  namestring
  citiesarray of object
  3 child fields
  keystringrequired
  radiusnumber
  distanceUnitstring
  One of mile, kilometer.
  zipsarray of object
  2 child fields
  keystringrequired
  namestring
  placesarray of object
  1 child field
  keystringrequired
  neighborhoodsarray of object
  1 child field
  keystringrequired
  customLocationsarray of object
  6 child fields
  latitudenumberrequired
  -90 to 90.
  longitudenumberrequired
  -180 to 180.
  radiusnumberrequired
  distanceUnitstringrequired
  One of mile, kilometer.
  namestring
  addressstring
- ageMininteger
  13 to 100.
- ageMaxinteger
  13 to 100.
- genderstring
  One of all, male, female.
- incomeTierstring
  One of top_5, top_10, top_10_25, top_25_50.
- languagesarray of string
- interestsarray of object
  2 child fields
  idstringrequired
  namestring
- behaviorsarray of object
  2 child fields
  idstringrequired
  namestring
- workPositionsarray of object
  2 child fields
  idstringrequired
  namestring
- workEmployersarray of object
  2 child fields
  idstringrequired
  namestring
- workIndustriesarray of object
  2 child fields
  idstringrequired
  namestring
- industriesarray of string
- companySizesarray of string
- senioritiesarray of string
- jobFunctionsarray of string
- skillsarray of string
- audienceIncludearray of string
- audienceExcludearray of string
- communitiesarray of string
- excludedCommunitiesarray of string
- conversationKeywordsarray of string
- excludedConversationKeywordsarray of string
campaignTypestring
One of SPONSORED_UPDATES, SPONSORED_INMAILS, DYNAMIC.
timeRangeStartintegerrequired
timeRangeEndintegerrequired
objectiveTypestring
optimizationTargetstring
dailyBudgetnumber
totalBudgetnumber
currencystring
3 to 3 characters.
competingBidobject
- bidTypestringrequired
  One of CPM, CPC, CPV.
- amountnumberrequired
enableAudienceNetworkboolean
enableAudienceExpansionboolean
connectedTelevisionOnlyboolean

Example

curl -X POST "https://api.pozy.ai/v1/ads/targeting/supply-forecast" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "696e0b682d0a31188e7a2ba9",
  "adAccountId": "666219aad7bab67ace411e4f",
  "spec": {
    "userOs": [
      "string"
    ],
    "userDevice": [
      "string"
    ],
    "countries": [
      "string"
    ]
  },
  "timeRangeStart": 1,
  "timeRangeEnd": 1
}'

const res = await fetch("https://api.pozy.ai/v1/ads/targeting/supply-forecast", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.POZY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    accountId: "696e0b682d0a31188e7a2ba9",
    adAccountId: "666219aad7bab67ace411e4f",
    spec: {
      userOs: [
        "string"
      ],
      userDevice: [
        "string"
      ],
      countries: [
        "string"
      ]
    },
    timeRangeStart: 1,
    timeRangeEnd: 1
  }),
});
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/targeting/supply-forecast",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    json={
        "accountId": "696e0b682d0a31188e7a2ba9",
        "adAccountId": "666219aad7bab67ace411e4f",
        "spec": {
            "userOs": [
                "string",
            ],
            "userDevice": [
                "string",
            ],
            "countries": [
                "string",
            ],
        },
        "timeRangeStart": 1,
        "timeRangeEnd": 1,
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

availablebooleanrequired
forecastarray of object
- metricTypestring
- granularitystring
  One of DAILY, SEVEN_DAY, THIRTY_DAY, CUSTOM.
- timeSeriesarray of object
  3 child fields
  - timestampinteger
  - valuenumber
  - adForecastRangeobject
    2 child fields
    lowEndnumber
    highEndnumber

200 response

{
  "available": true,
  "forecast": [
    {
      "metricType": "string",
      "granularity": "DAILY",
      "timeSeries": [
        {
          "timestamp": 1,
          "value": 12.5,
          "adForecastRange": {
            "lowEnd": 12.5,
            "highEnd": 12.5
          }
        }
      ]
    }
  ]
}

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.

More in Ad Targeting

GETSearch targeting interests GETSearch targeting options GETBrowse targeting categories POSTEstimate audience reach POSTSuggested bid and budget bounds