Skip to main content
POST
Report 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
start_date
string
required

Start date (YYYY-MM-DD)

end_date
string
required

End date (YYYY-MM-DD)

advertiser_id
string

Omit it: it defaults to the advertiser this workspace is connected to, and any other advertiser is refused.

report_type
enum<string>
default:BASIC

BASIC = standard metrics, AUDIENCE = demographic breakdown

Available options:
BASIC,
AUDIENCE,
PLAYABLE_MATERIAL,
CATALOG
data_level
enum<string>
default:AUCTION_CAMPAIGN

Reporting level

Available options:
AUCTION_CAMPAIGN,
AUCTION_ADGROUP,
AUCTION_AD
dimensions
string[]

Grouping dimensions: campaign_id, adgroup_id, ad_id, stat_time_day, country_code, gender, age, etc.

metrics
string[]

Metrics: spend, impressions, clicks, conversions, ctr, cpc, cpm, reach, frequency, video_views_p25/p50/p75/p100

filters
object[]
page
number
default:1
Required range: x >= 1
page_size
number
default:100
Required range: 1 <= x <= 1000

Response

200 - application/json

Success