Skip to main content
POST
Attribution-data 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
level
enum<string>
required

Level of insights to retrieve

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

ID of the object to get insights for. Omit it to use the connected ad account (recommended for account-wide queries at any level). Otherwise pass a campaign ID, ad set ID, or ad ID matching level. Account IDs other than the connected account are rejected. Passing a page/business/user ID returns Meta error #100.

date_preset
enum<string>

Date preset for insights

Available options:
today,
yesterday,
last_3d,
last_7d,
last_14d,
last_28d,
last_30d,
last_90d,
this_week_mon_today,
this_week_sun_today,
last_week_mon_sun,
last_week_sun_sat,
this_month,
last_month,
this_quarter,
last_quarter,
this_year,
last_year,
maximum,
data_maximum
time_range
object

Custom date range for insights

fields
string[]

Specific fields to retrieve (e.g., impressions, clicks, spend)

breakdowns
string[]

Breakdown dimensions (e.g., age, gender, placement)

time_increment

Time granularity: "monthly" for monthly rows, "all_days" for daily rows, or a number 1-90 for N-day increments

Available options:
monthly,
all_days
limit
number
default:25

Number of insights to return

Required range: 1 <= x <= 100
after
string

Cursor for the next page: pass back the pagination.next_cursor value from a previous response. Keep every other parameter identical, or the cursor no longer matches the query it came from.

Response

200 - application/json

Success