Skip to main content
GET
Themes list

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

Query Parameters

from
string<date>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
to
string<date>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
source
enum<string>
default:META
Available options:
META,
TIKTOK,
GOOGLE,
SNAPCHAT,
REDDIT
sortBy
enum<string>
default:spend
Available options:
spend,
impressions,
reach,
clicks,
frequency,
ctr,
cpm,
cpc,
thumbstop,
conversion,
comments,
winnerCreativeCount,
creativeCount,
totalAdCount,
activeCreativeCount
sortOrder
enum<string>
default:desc
Available options:
asc,
desc
sortEvent
string
Required string length: 1 - 256
sortSubMetric
enum<string>
Available options:
costPer,
count,
rate,
value,
roas

Response

200 - application/json

Success

status
enum<string>
required
Available options:
never_synced,
syncing,
preparing,
ready,
partial,
failed
lastClusteredAt
string | null
required
coverage
object
required
themes
object[]
required