Facebook Ads
Campaigns Config
GET
Retrieve Facebook Ads campaign configuration data including campaign settings, objective, budget configurations, and campaign-level metadata.
This endpoint provides detailed configuration information for campaigns.
Dimensions Available:
- Configuration ID, name, objective
- Status: effective status, creation time, buying type
- Budget: daily budget, lifetime budget
Limitations:
- Maximum 5000 records per page
- Supports date filtering via
dateStart(ISO 8601 format) - Supports sorting via
orderByandorderDirection(ASC/DESC)
Filters:
organizationId(required)userId(optional)integrationName(optional)dateStart(optional)
Note: This endpoint returns configuration data and may not support
dateEndfiltering.
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
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/campaigns-config?organizationId=organization_123&dateStart=2024-01-01"{ "data": [ { "id": "string", "name": "string", "objective": "string", "effective_status": "string", "created_time": "2019-08-24T14:15:22Z", "buying_type": "string", "daily_budget": 0, "lifetime_budget": 0, "organization_id": "string", "user_id": "string", "document_id": "string", "inserted_at": "2019-08-24T14:15:22Z" } ], "meta": { "page": 0, "limit": 0, "hasNextPage": true, "hasPreviousPage": true }}