Facebook Ads
Ads
GET
Retrieve Facebook Ads data with comprehensive performance metrics aggregated at the ad level.
This endpoint provides ad-level insights including status, associated ad set and campaign information, and performance indicators.
Dimensions Available:
- Ad ID, adset ID, ad name
- Metrics: impressions, reach, frequency, clicks, CTR, inline link clicks, spend, CPC, CPM, website purchase ROAS
- Actions data (JSON)
- Date range (
date_start,date_stop)
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)
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?organizationId=organization_123&dateStart=2024-01-01&dateEnd=2024-12-31"{ "data": [ { "ad_id": "string", "adset_id": "string", "ad_name": "string", "impressions": 0, "reach": 0, "frequency": 0, "clicks": 0, "ctr": 0, "inline_link_clicks": 0, "inline_link_click_ctr": 0, "spend": 0, "cpc": 0, "cpm": 0, "quality_ranking": "string", "engagement_rate_ranking": "string", "conversion_rate_ranking": "string", "website_purchase_roas": 0, "date_start": "2019-08-24", "date_stop": "2019-08-24", "actions": "string", "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 }}