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
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.

level
enum<string>
default:campaign

One row per object at this level (plus any breakdowns).

Available options:
account,
campaign,
ad_group,
ad
object_id
string

Restrict to one campaign / ad group / ad id (matched to level).

Pattern: ^\d{6,25}$
metrics
string[]

Friendly metric names, e.g. impressions, clicks, spend, ctr, cpc, ecpm, reach, video_watched_100_percent, conversion_purchase_clicks. Default: the core group. See adside reddit report-fields list.

metric_groups
enum<string>[]

Bundles: core, video, conversions, value, app.

Available options:
core,
video,
conversions,
value,
app
breakdowns
string[]

Extra dimensions: date, hour, country, region, dma, community, interest, keyword, placement, os_type, gender, language, asset_id, carousel_card. Max 3 in total (the level counts as one). Reddit has no age breakdown.

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.

filter
string

Reddit filter syntax, e.g. campaign:effective_status==ACTIVE,ad:name=@promo (== exact, =@ contains, comma = OR).

conversion_events
string[]

Named custom pixel events to include (clicks, views, value).

sort_by
string

Metric to sort rows by (descending). Default spend.

format
enum<string>
default:markdown

json only when fields must be reused programmatically.

Available options:
markdown,
json
limit
integer
default:200
Required range: 1 <= x <= 1000

Response

200 - application/json

Success