Skip to main content
POST
Stats get

Authorizations

Authorization
string
header
required

A personal API key (adside_pat_…) or a token from adside login. Either carries the permissions of the person it belongs to.

Path Parameters

workspaceId
string
required
Minimum string length: 1

Body

application/json
entity_level
enum<string>
required

Which level of the hierarchy to pull stats for

Available options:
adaccount,
campaign,
adsquad,
ad
entity_id
string

Required for campaign/adsquad/ad. For adaccount, omit it: it defaults to the ad account this workspace is connected to, and any other account is refused.

granularity
enum<string>
default:DAY

DAY needs start_time/end_time within 31 days; HOUR within 7 days; TOTAL/LIFETIME need no date range (LIFETIME is finalized-only data).

Available options:
TOTAL,
DAY,
HOUR,
LIFETIME
breakdown
enum<string>

One call per parent: 'ad' at any level, 'adsquad' on a campaign, 'campaign' on an ad account.

Available options:
ad,
adsquad,
campaign
fields
string[]

Metric names, e.g. impressions, swipes, spend, video_views_5s

start_time
string

ISO 8601, required for DAY/HOUR granularity

end_time
string

ISO 8601, required for DAY/HOUR granularity

dimension
enum<string>

Insights breakdown dimension (DAY/TOTAL/LIFETIME only)

Available options:
GEO,
DEMO,
INTEREST,
DEVICE
pivot
string[]

Pivot fields for the chosen dimension, e.g. gender,age_bucket for DEMO

swipe_up_attribution_window
enum<string>

Default 28_DAY

Available options:
1_DAY,
7_DAY,
28_DAY
view_attribution_window
enum<string>

Default 1_DAY

Available options:
none,
1_HOUR,
3_HOUR,
6_HOUR,
1_DAY,
7_DAY

Response

200 - application/json

Success