Skip to main content
POST
Campaign-performance 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
customer_id
string

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

date_range
enum<string>
default:LAST_30_DAYS
Available options:
LAST_7_DAYS,
LAST_14_DAYS,
LAST_30_DAYS,
LAST_90_DAYS,
THIS_MONTH,
LAST_MONTH,
CUSTOM
start_date
string

YYYY-MM-DD, required when date_range is CUSTOM

end_date
string

YYYY-MM-DD, required when date_range is CUSTOM

campaign_ids
string[]
metrics
string[]

Metrics to retrieve, e.g. metrics.impressions, metrics.clicks, metrics.cost_micros

segments
string[]

Segment fields, e.g. segments.date, segments.device

order_by
string
limit
integer
default:100
Required range: 1 <= x <= 10000

Response

200 - application/json

Success