Skip to main content
POST
Creatives 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
source
enum<string>
default:META

Ad platform to read: META, TIKTOK, GOOGLE (YouTube video ads), LINKEDIN, SNAPCHAT or REDDIT. Defaults to META.

Available options:
META,
TIKTOK,
GOOGLE,
LINKEDIN,
SNAPCHAT,
REDDIT
from
string

Inclusive start date, yyyy-MM-dd. Use together with to; takes precedence over period.

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

Inclusive end date, yyyy-MM-dd.

Pattern: ^\d{4}-\d{2}-\d{2}$
period
enum<string>
default:last_7_days

Preset window used when from/to are omitted.

Available options:
today,
yesterday,
last_7_days,
last_4_weeks,
last_3_months,
last_12_months,
week_to_date,
month_to_date,
quarter_to_date,
year_to_date,
all_time,
last_30_days
limit
integer
default:10

How many creatives to return (1-20). Defaults to 10.

Required range: 1 <= x <= 20
format
enum<string>
default:all

Keep only video or static creatives. Defaults to all.

Available options:
all,
video,
static
sortBy
enum<string>
default:spend

Ranking column. conversion ranks by the conversion event (see conversionEvent / sortSubMetric). A column the platform cannot sort by falls back to spend.

Available options:
spend,
impressions,
reach,
clicks,
frequency,
ctr,
cpm,
cpc,
thumbstop,
conversion,
comments
sortOrder
enum<string>
default:desc

desc = highest first (use asc with cost metrics for cheapest).

Available options:
asc,
desc
sortSubMetric
enum<string>

With sortBy conversion: which conversion figure to rank by — count, costPer, rate, value or roas. Defaults to count.

Available options:
costPer,
count,
rate,
value,
roas
conversionEvent
string

Platform conversion event to report (e.g. a Meta action_type). Defaults to the workspace's primary mapped conversion for the platform.

Required string length: 1 - 256

Response

200 - application/json

Success

text
string
required