Skip to main content
POST
Active-entities 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
account_id
string

X ads account id (e.g. 18ce55xcrlv). Omit it: it defaults to the ads account this workspace is connected to, and any other account is refused.

entity
enum<string>
default:CAMPAIGN
Available options:
CAMPAIGN,
LINE_ITEM,
PROMOTED_TWEET,
FUNDING_INSTRUMENT,
PROMOTED_ACCOUNT,
MEDIA_CREATIVE
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 the account's time zone.

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

Last day (inclusive), YYYY-MM-DD, in the account's time zone. The exclusive end X wants is computed for you.

Pattern: ^\d{4}-\d{2}-\d{2}$
campaign_ids
string[]

Only entities under these campaigns.

Maximum array length: 200
Pattern: ^[0-9a-z]{1,12}$
line_item_ids
string[]

Only entities under these line items.

Maximum array length: 200
Pattern: ^[0-9a-z]{1,12}$

Response

200 - application/json

Success