Get report
get_reportRead-onlyIdempotent
Drill-down report: group by one or more dimensions; rows come back for the dimension at level (0-based), path carries the parent row keys when drilling deeper. Every row has key, label and the full metric set. compare=true adds the previous period (same length right before; the previous calendar month for this_month/last_month): each row gets prev (its metrics then, null = no traffic then) — date/week/month rows are matched to the same position in the previous window (22 Sep vs 15 Sep for 7days), drill-down paths are translated the same way — plus prev_totals and prev_range. The basis for "what changed / what dropped vs last week" questions.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| os | No | ||
| isp | No | ||
| city | No | ||
| path | No | Parent row keys for levels above `level` | |
| site | No | Placement / zone id as passed by the ad network | |
| sub1 | No | Filter by sub1 | |
| sub2 | No | Filter by sub2 | |
| sub3 | No | Filter by sub3 | |
| sub4 | No | Filter by sub4 | |
| sub5 | No | Filter by sub5 | |
| sub6 | No | Filter by sub6 | |
| sub7 | No | Filter by sub7 | |
| sub8 | No | Filter by sub8 | |
| sub9 | No | Filter by sub9 | |
| user | No | Workspace member id(s), comma-separated — the campaign owner at click time (needs the "See statistics per team member" permission; ignored otherwise) | |
| level | No | Which group_by level to return rows for (default 0) | |
| offer | No | Offer id | |
| sub10 | No | Filter by sub10 | |
| sub11 | No | Filter by sub11 | |
| sub12 | No | Filter by sub12 | |
| sub13 | No | Filter by sub13 | |
| sub14 | No | Filter by sub14 | |
| sub15 | No | Filter by sub15 | |
| device | No | mobile / tablet / desktop | |
| period | No | Reporting period (default 7days). Use 'custom' with date_from/date_to. | |
| source | No | Traffic source id | |
| browser | No | ||
| compare | No | Also return the previous period per row (`prev`) and in total (prev_totals) | |
| country | No | Country ISO alpha-2 code, e.g. ES | |
| date_to | No | YYYY-MM-DD (with period=custom) | |
| landing | No | Landing id | |
| campaign | No | Campaign ALIAS (the short code, not the numeric id) | |
| creative | No | Creative id from the click URL | |
| group_by | Yes | Dimension per drill-down level (`user` = the workspace member owning the campaign; needs the "See statistics per team member" permission) | |
| language | No | ||
| pwa_tags | No | Comma-separated tag ids — pwas carrying any of them | |
| referrer | No | ||
| utm_term | No | Exact utm_term value from the click URL | |
| date_from | No | YYYY-MM-DD (with period=custom) | |
| date_mode | No | Date attribution: 'conversion' (default) counts each conversion on the day its postback arrived; 'click' books it on the date of the click it belongs to | |
| pwa_group | No | Pwa group id | |
| smartlink | No | Smartlink id | |
| source_id | No | Source id as passed by the ad network | |
| offer_tags | No | Comma-separated tag ids — offers carrying any of them | |
| utm_medium | No | Exact utm_medium value from the click URL | |
| utm_source | No | Exact utm_source value from the click URL | |
| ad_campaign | No | The ad network's own campaign id (external_campaign_id) | |
| aff_network | No | Affiliate network id | |
| offer_group | No | Offer group id | |
| source_tags | No | Comma-separated tag ids — sources carrying any of them | |
| unique_only | No | Count unique clicks only | |
| utm_content | No | Exact utm_content value from the click URL | |
| exclude_bots | No | Exclude bot traffic (bots are counted by default) | |
| landing_tags | No | Comma-separated tag ids — landings carrying any of them | |
| source_group | No | Source group id | |
| utm_campaign | No | Exact utm_campaign value from the click URL | |
| campaign_tags | No | Comma-separated tag ids — campaigns carrying any of them | |
| landing_group | No | Landing group id | |
| campaign_group | No | Campaign group id | |
| smartlink_tags | No | Comma-separated tag ids — smartlinks carrying any of them | |
| connection_type | No | ||
| smartlink_group | No | Smartlink group id |