Zernio
APIFor you
Zernio
APIFor you
API Reference

Automated Rules

Rules

List ad rulesGETCreate an ad rulePOSTGet an ad ruleGETUpdate an ad rulePATCHDelete an ad ruleDELETE

Preview and History

Preview an ad rulePOSTList an ad rule's runsGET
Dashboard
OverviewPlatformsAPI ReferenceResources
Automated Rules

Preview an ad rule

Evaluates a rule against current metrics and returns what it would match right now, without acting on anything, sending a webhook or starting a cooldown. Works on disabled rules.

PlatformsMetaGoogleTikTokLinkedInPinterestX
POST
/v1/ads/rules/{ruleId}/preview

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

ruleId*string

Response Body

application/json

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.adrules.previewAdRule({  path: {    ruleId: 'rule_abc123',  },});console.log(data);
{  "evaluatedAt": "2019-08-24T14:15:22Z",  "today": "2019-08-24",  "timezone": "string",  "timezoneAssumed": true,  "currency": "string",  "matched": 0,  "objects": [    {      "id": "string",      "name": "string",      "campaignId": "string",      "matched": true,      "conditions": [        {          "metric": "spend",          "window": "today",          "op": ">",          "value": 0,          "actual": 0,          "met": true        }      ]    }  ]}
Was this page helpful?

Delete an ad rule

Deletes a rule and its run history. Changes the rule already made on the platform stay.

List an ad rule's runs

Lists a rule's scheduled runs, newest first: what each run evaluated, matched and did.