Appearance
List ads
Returns a paginated list of ads with metrics computed over an optional date range. Use source=all to include externally-synced ads from platform ad managers. If no date range is provided, defaults to the last 90 days. Date range is capped at 730 days max.
To find the Zernio ad behind a comment you see in Meta Business Manager, filter by platformAdId (the Meta ad ID), effectiveObjectStoryId (Facebook), or effectiveInstagramMediaId (Instagram) — those are the post/media the ad's engagement lives on, and are also returned on each ad's creative object. Then call GET /v1/ads/{adId}/comments with the returned ad id.
GET /v1/ads
Returns a paginated list of ads with metrics computed over an optional date range. Use source=all to include externally-synced ads from platform ad managers. If no date range is provided, defaults to the last 90 days. Date range is capped at 730 days max.
To find the Zernio ad behind a comment you see in Meta Business Manager, filter by platformAdId (the Meta ad ID), effectiveObjectStoryId (Facebook), or effectiveInstagramMediaId (Instagram) — those are the post/media the ad's engagement lives on, and are also returned on each ad's creative object. Then call GET /v1/ads/{adId}/comments with the returned ad id.
Parameters
None(query, any)limit(query, integer)source(query, string) — all (default) = Zernio-created + platform-discovered ads. zernio = restrict to Zernio-created only.status(query, any)platform(query, string)accountId(query, string) — Social account IDadAccountId(query, string) — Platform ad account ID (e.g. act_123 for Meta). Mirrors the same filter on /v1/ads/campaigns and /v1/ads/tree.profileId(query, string) — Profile IDcampaignId(query, string) — Platform campaign ID (filter ads within a campaign)platformAdId(query, string) — Meta ad ID. Returns the ad with this platform-side ad ID.effectiveObjectStoryId(query, string) — Facebook{pageId}_{postId}of the post the ad's engagement lives on (Metaeffective_object_story_id). Use to map a Business-Manager-visible post back to the Zernio ad.effectiveInstagramMediaId(query, string) — Instagram media ID of the boosted post (Metaeffective_instagram_media_id). Use to map a Business-Manager-visible IG post back to the Zernio ad.fromDate(query, string) — Start of metrics date range (YYYY-MM-DD). Defaults to 90 days ago.toDate(query, string) — End of metrics date range (YYYY-MM-DD). Defaults to today. Max 730-day range.
Responses
200 — Paginated ads
ads(array)pagination($ref)
401
403 — Ads access required. Legacy plans need the Ads add-on; included by default on usage-based plans.