Zernio
APIFor you
Zernio
APIFor you
API Reference

Reach & Frequency

Create reach-frequency predictionPOSTGet reach-frequency predictionGETCancel reach-frequency bookingDELETEReserve reach-frequency inventoryPOST
Dashboard
OverviewPlatformsAPI ReferenceResources
Reach & Frequency

Get reach-frequency prediction

Shows a Meta reach and frequency prediction, with its estimate and status.


PlatformsMeta
GET
/v1/ads/rf-predictions/{predictionId}

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.

In: header

Path Parameters

predictionId*string

Query Parameters

accountId*string
adAccountId*string

Response Body

application/json

application/json

application/json

application/json

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.reachandfrequency.getRfPrediction({  path: {    predictionId: 'prediction_abc123',  },  query: {    accountId: 'account_abc123',    adAccountId: 'adaccount_abc123',  },});console.log(data);
{  "adAccountId": "string",  "currency": "string",  "prediction": {    "predictionId": "string",    "status": "string",    "budget": 0,    "reach": 0,    "impressions": 0,    "minBudget": 0,    "maxBudget": 0,    "minReach": 0,    "maxReach": 0,    "frequencyCap": 0,    "startTime": 0,    "stopTime": 0,    "expiresAt": "string"  }}
Was this page helpful?

Create reach-frequency prediction

Quotes the reach or budget for a Meta reach and frequency campaign over a date range, without buying anything. This is a QUOTE, nothing is bought and no ad entities are created. Provide a date range plus exactly one of `budgetAmount` (Meta predicts reach) or `reach` (Meta predicts the budget). The response carries the estimate and its allowed bounds (min/max budget and reach). Predictions expire on their own; to buy, reserve one via POST /v1/ads/rf-predictions/{predictionId}/reserve and pass the RESERVED id to POST /v1/ads/create with `buyingType: "RESERVED"`. Reservation campaigns reject automatic placements. Top-level `placements` wins; when it is omitted, `targeting.placements` is used; when neither is set, placements default to Facebook feed (+ Instagram stream when a linked IG professional account resolves). Instagram placements require that IG account.

Cancel reach-frequency booking

Cancels a Meta reach and frequency reservation, releasing its locked price and inventory. Unreserved predictions expire on their own.