Skip to main content
POST
Pixel-stats 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
pixel_id
string
required

Pixel/dataset ID from adside meta account-pixels get; independent of ad-set attachment.

Pattern: ^\d+$
aggregation
enum<string>
default:event_total_counts

event_total_counts lists standard/custom event names and counts; event for time buckets; event_source for browser/server mix; event_processing_results for diagnostics; host/url for origins; match_keys/had_pii for matching. Returns Meta's original aggregation/value/event fields.

Available options:
browser_type,
custom_data_field,
device_os,
device_type,
event,
event_detection_method,
event_processing_results,
event_source,
event_total_counts,
event_value_count,
had_pii,
host,
match_keys,
pixel_fire,
url,
url_by_rule
start_time
integer

UTC Unix seconds. Defaults to the earliest retained time (seven days before request time). Meta retains only the last seven days.

Required range: 0 <= x <= 9007199254740991
end_time
integer

UTC Unix seconds, after start_time. Defaults to now.

Required range: 0 <= x <= 9007199254740991
event
string

Exact event name, including spaces/case, e.g. Lead Generated or Schedule.

Required string length: 1 - 256
event_source
string

Meta event-source filter, e.g. WEB_ONLY or SERVER_ONLY. The SDK defines this as a string; Meta validates supported values.

Required string length: 1 - 100
agent
string

Optional SDK agent filter; omit unless diagnosing a specific integration agent.

Required string length: 1 - 256
limit
integer
default:25

Maximum stats buckets requested per page; nested results also have a response-size cap.

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

Next-page cursor; requires the same explicit start_time/end_time and filters as the original query. The requested window is preserved, but Meta's rolling retention may remove oldest data between pages.

Required string length: 1 - 4096

Response

200 - application/json

Success