Facebook Ads
Actions
GET
Retrieve Facebook Ads actions data with detailed conversion and engagement metrics.
This endpoint provides action-level insights including conversion events, engagement actions, and their associated values segmented by action type.
Dimensions Available:
- Campaign ID, adset ID, ad ID
- Action type, count, action value
- Date start
Limitations:
- Maximum 5000 records per page
- Supports date filtering via
dateStartanddateEnd(ISO 8601 format) - Supports sorting via
orderByandorderDirection(ASC/DESC)
Filters:
organizationId(required)userId(optional)integrationName(optional)dateStart(optional)dateEnd(optional)
Note: Action types include conversions, engagements, clicks, and other Facebook-specific events.
ClientIdAuthClientSecretAuthheader
x-client-id<token>Client ID
header
x-client-secret<token>Client secret
organizationId*stringOrganization identifier (required)
userId?stringUser identifier (optional)
integrationName?stringIntegration name identifier (optional)
dateStart?stringStart date for filtering (optional, ISO 8601 format)
Format
datedateEnd?stringEnd date for filtering (optional, ISO 8601 format)
Format
datepage?integerPage number for pagination (optional)
Default
1limit?integerNumber of items per page (optional, max 5000)
Range
value <= 5000Default
500orderBy?stringField to order by (optional)
orderDirection?stringOrder direction (optional)
Value in
"ASC""DESC"Successful response
application/json- response
data?array<>meta?curl -X GET "https://example.com/v1/facebook/ads/actions?organizationId=organization_123&dateStart=2024-01-01&dateEnd=2024-12-31"{ "data": [ { "campaign_id": "string", "ad_id": "string", "adset_id": "string", "action_type": "string", "count": 0, "action_value": 0, "date_start": "2019-08-24", "organization_id": "string", "user_id": "string", "document_id": "string", "integration_name": "string", "inserted_at": "2019-08-24T14:15:22Z" } ], "meta": { "page": 0, "limit": 0, "hasNextPage": true, "hasPreviousPage": true }}