Skip to main content
POST
Performance rank

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
ad_account_id
string

Reddit ad account id (a2_…). Omit it: it defaults to the ad account this workspace is connected to, and any other account is refused.

dimension
string
default:ad

What to rank: campaign, ad_group, ad, community, keyword, interest, placement, country, region, os_type, gender, language.

metric
string
default:spend

Metric to rank by. Cost metrics (cpc, ecpm, *_ecpa) rank ascending.

min_spend
number
default:0

Ignore rows under this spend (account currency).

Required range: x >= 0
top_n
integer
default:10
Required range: 1 <= x <= 100
preset
enum<string>

Shortcut for a date range. Default last_7d when no start_date/end_date given.

Available options:
today,
yesterday,
last_7d,
last_14d,
last_30d,
this_month,
last_month
start_date
string

First day, YYYY-MM-DD, in time_zone_id.

Pattern: ^\d{4}-\d{2}-\d{2}$
end_date
string

Last day (inclusive), YYYY-MM-DD, in time_zone_id.

Pattern: ^\d{4}-\d{2}-\d{2}$
time_zone_id
string

IANA zone for the date boundaries, e.g. Europe/Paris. Defaults to the ad account's time zone.

Response

200 - application/json

Success