Reads one GAM campaign (order) — its details and lifetime delivery (impressions, CTR, viewability) — with optional breakdowns per cohort, per day, or per line item.
Example prompt
Break down that campaign’s delivery by cohort and by day so I can see which audiences drove impressions.
Parameters
string
required
The campaign id to read (from list_campaigns).
enum[]
Which breakdowns to include. Omit for the campaign’s totals only. each one of: targeted_cohorts, observed_cohorts, day, line_item.
string[]
Restrict every figure to these line items.
string[]
required
The workspaces the campaign runs across — pass the workspace_ids from the campaign’s list_campaigns row. min 1 item.
Returns
CampaignDetail object
required
The campaign’s details.
Show CampaignDetail
boolean
required
Whether the campaign is currently active — its end date is in the future.
string
Agency associated with the order, when GAM records one. Often absent.
string
required
Order end date (ISO 8601).
string
required
Campaign (order) name.
boolean
required
Whether the campaign uses Permutive targeting.
string
required
Order start date (ISO 8601).
CohortBreakdownItem[]
Per-cohort breakdown, when requested via include.
Show CohortBreakdownItem
WorkspaceAudience[]
This cohort’s available audience (estimated unique users, last 30 days) in each of the requested workspaces — showing where its users are collected.
Show WorkspaceAudience
integer (int64)
required
Estimated unique users (last 30 days) for the cohort available in this workspace; 0 = no recent activity here.
string (uuid)
required
One of the requested workspace ids.
string
required
Short cohort identifier. Pass to get_cohort_detail or as a measure_audiences reference.
enum
required
The cohort’s type (e.g. custom, lookalike). one of: custom, lookalike, contextual, standard, classificationModel, advertiser, curated.
number (double)
This cohort’s absolute click-through rate.
number (double)
required
This cohort’s click-through rate relative to the campaign’s overall CTR (cohort_ctr / campaign_ctr). 1.0 = the campaign average; >1 = clicks better than average, <1 = worse.
integer (int64)
required
This cohort’s impressions (per the reading in targeted).
string
required
Human-readable cohort name.
number (double)
This cohort’s impressions as a fraction of the campaign’s total (0..1).
boolean
required
Whether the campaign targets this cohort.
number (double)
This cohort’s viewable-impression percentage (0..1).
number (double)
required
Lifetime click-through rate.
CampaignDayItem[]
The campaign’s own delivery by day (impressions/CTR/viewability), for spotting trends over its flight. Present when day is in include.
Show CampaignDayItem
number (double)
required
The campaign’s click-through rate on this day.
string
required
The day (ISO 8601 date).
integer (int64)
required
The campaign’s impressions on this day.
number (double)
required
The campaign’s viewable-impression percentage on this day (0..1).
integer (int64)
required
Lifetime impressions delivered against the order (line-item-scoped when line_item_ids is set).
OrderComparison object
Comparison of the restricted impressions to the whole order. Present only when line_item_ids is set.
Show OrderComparison
number (double)
required
This figure as a fraction of the whole order’s figure (0..1).
number (double)
required
This figure divided by the order’s per-line-item average (1.0 = exactly average).
LineItemBreakdownItem[]
Per-line-item breakdown, when requested via include.
Show LineItemBreakdownItem
number (double)
required
This line item’s click-through rate.
integer (int64)
required
Impressions delivered by this line item.
string
required
The GAM line item id.
string
required
Line item name.
integer (int64)
required
Permutive-targeted impressions delivered by this line item (capped).
number (double)
required
This line item’s viewable-impression percentage (0..1).
OtherCohorts object
The aggregate of cohorts on this campaign not listed in cohort_breakdown (not visible to you, or not resolvable in the cohort catalogue). Present with the cohort breakdown when any were dropped, so the breakdown accounts for all cohort delivery. Absent when nothing was dropped.
Show OtherCohorts
integer (int32)
required
How many cohorts are aggregated here — those beyond the top-by-impressions cap, plus any not resolvable in the catalogue (owned outside this workspace, or uncatalogued). For observed_cohorts this is often large and is not a defect.
number (double)
required
Impression-weighted click-through rate across those cohorts.
integer (int64)
required
Summed impressions of those cohorts (same reading as the individual rows: targeted or observed).
number (double)
These cohorts’ combined impressions as a fraction of the campaign total (0..1).
number (double)
required
Impression-weighted viewable-impression percentage across those cohorts (0..1).
number (double)
required
Lifetime viewable-impression percentage (0..1).
Assistant
Responses are generated using AI and may contain mistakes.