Ad Report - Whop Docs

{ "summary": { "clicks": 42, "impressions": 42, "reach": 42, "spend": 6.9, "ctr": 6.9, "cpc": 6.9, "cpm": 6.9, "frequency": 6.9, "result_count": 42, "result_label_override": "<string>", "cost_per_result": 6.9, "roas": 6.9 }, "granularity": [ { "bucket_start": "2023-12-01T05:00:00.401Z", "stat_date": "2023-12-01T05:00:00.401Z", "stat_hour": 42, "spend": 6.9, "impressions": 42, "clicks": 42, "reach": 42, "result_count": 42, "result_label_override": "<string>" } ], "breakdown": [ { "id": "<string>", "name": "<string>", "summary": { "clicks": 42, "impressions": 42, "reach": 42, "spend": 6.9, "ctr": 6.9, "cpc": 6.9, "cpm": 6.9, "frequency": 6.9, "result_count": 42, "result_label_override": "<string>", "cost_per_result": 6.9, "roas": 6.9 }, "granularity": [ { "bucket_start": "2023-12-01T05:00:00.401Z", "stat_date": "2023-12-01T05:00:00.401Z", "stat_hour": 42, "spend": 6.9, "impressions": 42, "clicks": 42, "reach": 42, "result_count": 42, "result_label_override": "<string>" } ] } ] }

An ads performance report. Always returns a summary. The granularity field contains a per-bucket time series when the granularity arg is set; the breakdown field contains per-entity rows when the breakdown arg is set.

summary

object

required

Aggregate totals and rates over the date range.

Show child attributes

granularity

object[] | null

required

Per-bucket time series over the date range, ordered ascending by bucketStart. null when the granularity arg on adReport is omitted; otherwise contains rows at the requested grain (daily or hourly).

Show child attributes

breakdown

object[] | null

required

Per-entity rows over the date range. null when the breakdown arg on adReport is omitted; otherwise contains one row per ad campaign, ad group, or ad inside the requested scope at the requested level.

Show child attributes

Documentation Index