API reference

Response

{
  "account": {
    "id": "01JB…",
    "name": "Acme",
    "type": "advertiser",
    "currency": "USD"
  },
  "token": {
    "id": "01JD…",
    "name": "BI export",
    "prefix": "dsp_a1b2c3d4",
    "scopes": [
      "stats.read"
    ],
    "expiresAt": "2027-01-16T08:00:00.000Z"
  }
}

Response

{
  "period": {
    "from": "2026-09-18",
    "to": "2026-10-17"
  },
  "currency": "USD",
  "totals": {
    "spend": 125000,
    "impressions": 980000,
    "clicks": 6400,
    "ctr": 0.0065,
    "conversions": 212,
    "cpa": 590,
    "roas": 3.1
  },
  "rows": [
    {
      "key": "01JC0Q…",
      "label": "Spring sale",
      "metrics": {
        "spend": 80000,
        "impressions": 610000,
        "clicks": 4100,
        "conversions": 150
      }
    }
  ],
  "rowsTotal": 1
}

Response

[
  {
    "key": "14",
    "label": "14:00",
    "impressions": 41000,
    "clicks": 270,
    "conversions": 9,
    "spend": 5200,
    "ctr": 0.0066,
    "costPerKpi": 578
  }
]

Response

{
  "items": [
    {
      "id": "01JC0Q6Z8M2R7K4S9T1V3W5X7Y",
      "name": "Spring sale",
      "goal": "sales",
      "status": "live",
      "pricingModel": "cpm",
      "dailyBudget": 5000,
      "totalBudget": null,
      "startAt": "2026-10-01T00:00:00.000Z",
      "endAt": null,
      "channels": [
        {
          "channel": "display",
          "sharePct": 60
        },
        {
          "channel": "ctv",
          "sharePct": 40
        }
      ]
    }
  ],
  "total": 1,
  "page": 1,
  "pageSize": 25
}

Response

{
  "id": "01JC0Q6Z8M2R7K4S9T1V3W5X7Y",
  "name": "Spring sale",
  "goal": "sales",
  "status": "live",
  "pricingModel": "cpm",
  "dailyBudget": 5000,
  "totalBudget": null,
  "startAt": "2026-10-01T00:00:00.000Z",
  "endAt": null,
  "channels": [
    {
      "channel": "display",
      "sharePct": 60
    },
    {
      "channel": "ctv",
      "sharePct": 40
    }
  ]
}

Body

• goal (string, required) The campaign goal, e.g. sales, leads, app_installs, awareness, traffic, video_views.
• name (string) Up to 120 characters.
• kpiTarget (integer) Target cost per result in cents (×100 for ROAS: 250 = 2.5x). Omit for the benchmark.
• pricingModel (string) How you are charged (default cpm).
• unitPrice (integer) All-in price per billable unit in cents; required for every model but cpm.
• channels (array) Starting mix: [{ channel, sharePct }]. Omit for the recommended mix.

{
  "goal": "sales",
  "name": "Spring sale"
}

Response

{
  "id": "01JC0Q6Z8M2R7K4S9T1V3W5X7Y",
  "name": "Spring sale",
  "goal": "sales",
  "status": "draft",
  "pricingModel": "cpm",
  "dailyBudget": 5000,
  "totalBudget": null,
  "startAt": "2026-10-01T00:00:00.000Z",
  "endAt": null,
  "channels": [
    {
      "channel": "display",
      "sharePct": 60
    },
    {
      "channel": "ctv",
      "sharePct": 40
    }
  ]
}

Body

• text (string, required) The request in plain words, up to 500 characters (English or Hebrew).
• locale (string) Language of the summary (en or he); defaults to the sentence's own.

{
  "text": "$50 a day for my app in Israel"
}

Response

{
  "campaign": {
    "id": "01JC…",
    "name": "Acme – App installs",
    "status": "draft",
    "goal": "installs",
    "dailyBudget": 5000,
    "currency": "USD",
    "geo": [
      "IL"
    ],
    "interests": []
  },
  "defaulted": [],
  "summary": "Created the draft \"Acme – App installs\": App installs, $50/day, Israel.\nReview it, add creatives and launch it from the wizard. Nothing runs until it is launched.",
  "reviewPath": "/wizard/01JC…/audience"
}

Body

• name (string) Up to 120 characters.
• dailyBudget (integer) Daily budget in cents (at least 500).
• totalBudget (integer | null) Lifetime budget in cents; null for none.
• startAt (string) ISO date-time.
• endAt (string | null) ISO date-time; null to run until stopped.
• kpiTarget (integer) Target cost per result in cents.
• autopilot (boolean) Let the optimizer move budget between channels.
• channels (array) [{ channel, sharePct, pinned? }].
• audiences (array) [{ audienceId }].
• creativeIds (array) Creative ids to run.
• targeting (object) { geo, cities, ageMin, ageMax, genders, devices, os, languages… } (any subset).

{
  "dailyBudget": 7500
}

Response

{
  "id": "01JC0Q6Z8M2R7K4S9T1V3W5X7Y",
  "name": "Spring sale",
  "goal": "sales",
  "status": "live",
  "pricingModel": "cpm",
  "dailyBudget": 7500,
  "totalBudget": null,
  "startAt": "2026-10-01T00:00:00.000Z",
  "endAt": null,
  "channels": [
    {
      "channel": "display",
      "sharePct": 60
    },
    {
      "channel": "ctv",
      "sharePct": 40
    }
  ]
}

Response

{
  "domain": "news.example.com",
  "item": {
    "id": "01JE…",
    "name": "News Example",
    "kind": "web",
    "score": 82,
    "lowViewability": false,
    "highIvt": false
  },
  "packages": [
    {
      "id": "01JF…",
      "name": "News sites",
      "hasItem": false
    }
  ]
}

Body

• name (string, required) Up to 80 characters.
• itemIds (array) Library placement ids (from /library/sites).

{
  "name": "news.example.com",
  "itemIds": [
    "01JE…"
  ]
}

Response

{
  "package": {
    "id": "01JF…",
    "name": "news.example.com"
  }
}

Body

• itemIds (array, required) Library placement ids.

{
  "itemIds": [
    "01JE…"
  ]
}

Response

{
  "balanceCents": 245000,
  "currency": "USD"
}

Body

• url (string, required) An https address that answers 2xx within 10 seconds.
• events (string[], required) Events to send, such as campaign.launched or wallet.low.
• description (string) A note to tell webhooks apart.

{
  "url": "https://hooks.zapier.com/hooks/standard/123/abc/",
  "events": [
    "campaign.launched",
    "wallet.low"
  ]
}

Response

{
  "item": {
    "id": "01JF…",
    "url": "https://hooks.zapier.com/hooks/standard/123/abc/",
    "events": [
      "campaign.launched",
      "wallet.low"
    ],
    "active": true
  },
  "secret": "whsec_…"
}

Response

{
  "ok": true
}

Response

{
  "id": "evt_01JF…",
  "type": "campaign.launched",
  "createdAt": "2026-10-26T08:00:00.000Z",
  "account": {
    "id": "01JB…"
  },
  "data": {
    "campaign": {
      "id": "01JC…",
      "name": "Spring sale"
    }
  }
}