Zernio
Zernio
API Reference

Reach & Frequency

Create a Reach & Frequency predictionPOSTRead a Reach & Frequency predictionGETCancel a Reach & Frequency reservationDELETEReserve a Reach & Frequency predictionPOST
Dashboard
llms.txtOpenAPI
OverviewPlatformsAPI ReferenceResources
Reach & Frequency

Create a Reach & Frequency prediction

Creates an R&F prediction — 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.

PlatformsMeta
POST
/v1/ads/rf-predictions

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication - use your Zernio API key as a Bearer token

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

{  "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 click-to-message ad (WhatsApp / Messenger / Instagram Direct)

Creates a click-to-message ad; `destination` selects where the tapped ad opens a conversation: WhatsApp, the Page's Messenger inbox or the linked Instagram account's Direct inbox. The ad set is created with the matching destination_type and CONVERSATIONS optimization; the campaign objective defaults to OUTCOME_ENGAGEMENT. Supports single-creative and multi-creative shapes. Supersedes POST /v1/ads/ctwa (deprecated, equivalent to `destination: whatsapp`).

Read a Reach & Frequency prediction

Next Page

accountId*string

Zernio SocialAccount id (posting or ads variant).

adAccountId*string

Platform ad account id (Meta act_, Google customer id, LinkedIn account id, ...).

budgetAmount?number

Whole currency units. Exactly one of budgetAmount / reach.

reach?integer

Target unique reach. Exactly one of budgetAmount / reach.

startDate*string

Campaign window start (must be in the future).

Formatdate-time
endDate*string
Formatdate-time
frequencyCap?integer

Max impressions per person over the window.

Range1 <= value <= 90
targeting?

Canonical camelCase TargetingSpec (same shape as /v1/ads/create's targeting). Defaults to countries: [US].

placements?

Meta placements object (same shape as /v1/ads/create's placements).