Ad Creatives
Retrieve Facebook Ad creatives data grouped by ads with comprehensive creative and ad association information.
This endpoint provides creative-level insights with ad associations, including filtering capabilities for creative attributes.
Dimensions Available:
- Creative ID, name, object type, status, optimization type, ad ID, ad created time
- Media: Instagram permalink URL, thumbnail URL, title, video ID, image URL
- Configuration: URL tags, ad formats (JSON), website link, call to action types (JSON), title text
- Targeting: age range (min/max), publisher platforms (JSON)
- Positions: Facebook, Instagram, Messenger, Audience Network configurations
- Additional: page ID, Instagram user ID, story specifications, reasons to shop, shops bundle
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)creativeId(optional, accepts a single id or a comma-separated list)creativeName(optional)objectType(optional)optimizationType(optional)videoId(optional)adId(optional)
ClientIdAuthClientSecretAuthx-client-id<token>Client ID
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)
datedateEnd?stringEnd date for filtering (optional, ISO 8601 format)
datepage?integerPage number for pagination (optional)
1limit?integerNumber of items per page (optional, max 5000)
value <= 5000500orderBy?stringField to order by (optional)
orderDirection?stringOrder direction (optional)
"ASC""DESC"creativeId?|array<string>Filter by creative identifier. Accepts a single id (creativeId=123), a comma-separated list (creativeId=123,456) or repeated parameters (creativeId=123&creativeId=456). Multiple ids are matched with an SQL IN clause.
creativeName?stringFilter by creative name
objectType?stringFilter by object type
optimizationType?stringFilter by optimization type
videoId?stringFilter by video identifier
adId?stringFilter by ad identifier
Successful response
application/json- response
data?array<>meta?curl -X GET "https://example.com/v1/facebook/ads/creatives?organizationId=organization_123&dateStart=2024-01-01&dateEnd=2024-12-31&creativeId=123%2C456"{ "data": [ { "creative_id": "string", "creative_name": "string", "object_type": "string", "status": "string", "ad_id": "string", "ad_created_time": "2019-08-24T14:15:22Z", "instagram_permalink_url": "string", "thumbnail_url": "string", "title": "string", "video_id": "string", "image_url": "string", "url_tags": "string", "optimization_type": "string", "ad_formats": {}, "website_link": "string", "call_to_action_types": {}, "title_text": "string", "age_max": 0, "age_min": 0, "publisher_platforms": {}, "facebook_positions": {}, "instagram_positions": {}, "messenger_positions": {}, "audience_network_positions": {}, "reasons_to_shop": true, "shops_bundle": true, "page_id": "string", "instagram_user_id": "string", "story_spec_link": "string", "story_spec_link_name": "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 }}