Integration Guide
Connection Options
There are 2 connection options you have when creating an advertising campaign for your customers.
Option 1: Use Your Ad Accounts + Pages
Option 1 + 2: Use Your Ad Accounts + Pages
In this approach, you use your own Facebook ad accounts and pages to run ads for your customers. This option is the most seamless in terms of integration, as it avoids requiring your customers to connect their own accounts.
Tradeoffs:
- Pros:
- Seamless integration without additional customer login steps.
- Centralized management using your existing Facebook assets.
- Cons:
- Customers cannot select an Instagram post they’ve already uploaded.
- You will need to have the customer upload image or video assets and supply the asset URLs when creating a campaign.
Option 2: Allow Customers to Use Their Ad Accounts + Pages
Option 1 + 2: Use Your Ad Accounts + Pages
This option allows customers to connect and use their own Facebook ad accounts and pages. It gives them full control over their assets but involves a more complex setup.
Tradeoffs:
- Pros:
- Customers can manage and use their own ad accounts and pages.
- Cons:
- This is the most cumbersome option and requires the longest buildout.
- You are responsible for ensuring that each customer’s Facebook page and Instagram page are properly connected.
- You must verify that the customer's ad account is in a valid status and provide notifications if it is not.
Option 3: Hybrid Connection
In the hybrid approach, you run the ads using your own Facebook ad accounts and pages while allowing customers to connect their Facebook and Instagram pages. This allows customers to select an Instagram post (or other IG content) they’ve previously uploaded, while still leveraging your ad management infrastructure.
Tradeoffs:
- Pros:
- Ads are run directly from your ad account and Facebook pages, ensuring consistency in campaign management.
- Customers can use their own Instagram content in the campaign.
- Cons:
- You must ensure that customers have a valid Facebook page and Instagram page connected.
- There is additional overhead to validate that their connected pages and ad account statuses are in good standing before launching a campaign.
3. Flows
A simple workflow for using the API includes the following steps:
-
Retrieve a list of campaigns that have been created.
-
For each campaign, you can access its details, including:
- General campaign information.
- Analytics generated during its execution.
-
Create and Configure New Campaigns:
Use the API to create and set up new campaigns tailored to your requirements.
-
Update Ongoing Campaigns:
Explore the available workflows for updating a campaign currently in progress.
3.1 Retrieving the List of Campaigns
You can retrieve the list of campaigns using the following endpoint:
curl -X 'GET' \
'{{ADVERTISING_API}}/v1/campaign' \
-H 'accept: application/json' \
-H 'x-api-key: {{YOUR_API_KEY}}' This request can also include specific filters as query parameters to segment the campaigns more effectively.
Example with query parameters:
curl -X 'GET' \
'{{ADVERTISING_API}}/v1/campaign?campaign_type=boost_instagram&status=IN_REVIEW&limit=10&offset=2' \
-H 'accept: application/json' \
-H 'x-api-key: {{YOUR_API_KEY}}'Available Query Parameters:
status: Filter campaigns by their status (e.g., active, paused, completed).type: Filter campaigns by their type (e.g., boost_instagram).date.between.start: Retrieve campaigns starting from a specific date (format:YYYY-MM-DD).date.between.end: Retrieve campaigns ending before a specific date (format:YYYY-MM-DD).budget.between.start: Retrieve campaigns start before a specific budget.budget.between.end: Retrieve campaigns ending before a specific budget.limit: Retrieve campaigns with a limit (for paginations)ofsset: Retrieve campaigns a skip/offset for pagination
You can explore this endpoint further in the API Reference under the Campaigns section.
Expected Response
The expected response for this endpoint follows a schema similar to the one below:
{
"data": {
"campaigns": [
{
"id": 3863,
"status": "IN_REVIEW",
"brand_id": 574,
"campaign_metadata": {
"start_date": "2024-08-20T05:00:00.000Z",
"end_date": "2024-08-21T05:00:00.000Z",
"campaign_type": "link_clicks",
"budget": 57000
}
}
],
"count": 49,
"total_pages": 5
},
"status": 200
}Response Details:
data: Contains the core information.campaigns: A list of campaigns matching the query. Each campaign includes:id: Unique identifier for the campaign.status: Current status of the campaign (e.g.,IN_REVIEW,ACTIVE,PAUSED).brand_id: The brand associated with the campaign.campaign_metadata: Metadata about the campaign, including:start_date: Campaign start date in ISO format.end_date: Campaign end date in ISO format.campaign_type: Type of campaign (e.g.,link_clicks,video_views).budget: Total budget allocated to the campaign.
count: Total number of campaigns matching the filters.total_pages: Number of pages available for paginated results.
status: HTTP status code indicating the result of the request (e.g.,200for success)
interface CampaignMetadata {
start_date: string; // ISO 8601 format date string
end_date: string; // ISO 8601 format date string
campaign_type: string; // e.g., 'link_clicks', 'video_views'
budget: number; // Total budget allocated for the campaign
}
interface Campaign {
id: number; // Unique identifier for the campaign
status: string; // e.g., 'IN_REVIEW', 'ACTIVE', 'PAUSED'
brand_id: number; // The brand associated with the campaign
campaign_metadata: CampaignMetadata;
}
interface CampaignsResponse {
data: {
campaigns: Campaign[]; // Array of campaigns
count: number; // Total number of campaigns matching the filters
total_pages: number; // Total number of pages available for paginated results
};
status: number; // HTTP status code (e.g., 200 for success)
}3.2 Get Campaign Details
The flow for retrieving a campaign's details consists of four endpoints:
- Fetch campaign information: Retrieve the details of a previously created campaign.
- Analytics endpoints: Three endpoints that provide performance data at the creative and campaign levels.
Below are examples of how to call these endpoints, along with the expected responses:
3.2.1 Fetch Campaign Information
Endpoint: GET /advertising/v1/campaign/{id}
Description: Fetch the details of a specific campaign using its unique ID.
Request Example:
curl -X 'GET' \
'{{ADVERTISING_API}}/v1/campaign/12345' \
-H 'accept: application/json' \
-H 'x-api-key: {{YOUR_API_KEY}}'-
Expected Response:
{ "data": { "id": 5195, "brand_id": 246, "status": "IN_REVIEW", "campaign_metadata": { "links": null, "budget": 550, "status": "SUBMITTED", "content": { "name": "Traidores", "slug": "traidores", "type": "single", "thumbnail_url": "https://i.scdn.co/image/ab67616d0000b273f5c9e3c13e1b034879eed353" }, "endDate": "2025-05-20T15:00:00.000Z", "creative": { "all": [ { "url": "https://scontent-ord5-2.xx.fbcdn.net/v/t45.1600-4/476444813_6740722863286_5298702721919651348_n.jpg?_nc_cat=103&ccb=1-7&_nc_sid=890911&_nc_ohc=LfKEIubsAocQ7kNvgFGr_AO&_nc_oc=Adh0T2_M085OU4FmkrAXaRnrsvFGHzv1XVfjY6tVRjqxUW7zntc34l2P7tuQf0kkNyA&_nc_zt=1&_nc_ht=scontent-ord5-2.xx&edm=AJNyvH4EAAAA&_nc_gid=AaKUTTjiFq0IQlI4yfXKNDY&oh=00_AYCa1u54eR9Kp8yHROliiGFvDhVDuT-CkaoM4cC5SsqeGA&oe=67BD5531", "name": "sunflower.jpg", "type": "image", "fb_id": "02fdb8effcac18c06ca00f946781b6d5", "width": 600, "height": 400, "thumbnail": "https://scontent-ord5-2.xx.fbcdn.net/v/t45.1600-4/476444813_6740722863286_5298702721919651348_n.jpg?stp=dst-jpg_p168x128_tt6&_nc_cat=103&ccb=1-7&_nc_sid=189157&_nc_ohc=LfKEIubsAocQ7kNvgFGr_AO&_nc_oc=Adh0T2_M085OU4FmkrAXaRnrsvFGHzv1XVfjY6tVRjqxUW7zntc34l2P7tuQf0kkNyA&_nc_zt=1&_nc_ht=scontent-ord5-2.xx&edm=AJNyvH4EAAAA&_nc_gid=AaKUTTjiFq0IQlI4yfXKNDY&oh=00_AYBn2KUXLwsfykj0zZpu4piWnLUBzVo90hCUPph_OJJG3g&oe=67BD5531", "formatType": "feed" } ] }, "currency": "MXN", "startDate": "2025-05-20T05:00:00.000Z", "status_notes": null, "campaign_type": "record_streams", "campaign_input": { "goal": "increase_record_streams", "brand": { "id": 246, "name": "Skrlth", "slug": "skrlth-test", "tier": "pro", "image": "https://i.scdn.co/image/ab6761610000e5ebb23a44c0a1dced197a02dbaf", "website": { "bgType": "artwork", "bgColor": "#000", "titleText": null, "socialIcons": [ { "key": "0", "url": "", "width": "25", "height": "25", "enabled": true, "rounded": true, "placeholder": "Facebook profile URL", "backgroundColor": "" }, { "key": "1", "url": "", "width": "25", "height": "25", "enabled": true, "rounded": true, "placeholder": "Instagram profile URL", "backgroundColor": "" }, { "key": "2", "url": "", "width": "25", "height": "25", "enabled": true, "rounded": true, "placeholder": "TikTok profile URL", "backgroundColor": "" }, { "key": "3", "url": "", "width": "25", "height": "25", "enabled": true, "rounded": true, "placeholder": "X profile URL", "backgroundColor": "" }, { "key": "4", "url": "", "width": "25", "height": "25", "enabled": true, "rounded": true, "placeholder": "YouTube profile URL", "backgroundColor": "" } ], "buttonConfig": "stacked", "primaryColor": "#7C18F7", "secondaryColor": "#000000", "enableSocialIcons": true, "removeSymphonyBrand": false, "addAffiliateLinkToLogo": true }, "currency": { "code": "MXN", "symbol": "$" }, "createdAt": "2022-03-25T00:11:31.220Z", "updatedAt": "2025-02-20T16:20:29.712Z", "connections": { "tiktok": { "url": "https://tiktok.com/@skrlth.cln", "username": "skrlth.cln" }, "audiomack": { "id": 31519512, "name": "JAY Z", "genres": [ "rap" ], "url_slug": "jay-z", "followers": 71467, "thumbnail_url": "https://assets.audiomack.com/jay-z/e8f9f8e6cd1a2fc9ab91af864ef88239b136863cce159f01f6907661da4ddde6.jpeg" }, "chartmetric": { "id": 5919680 }, "facebook_page": { "id": "pageID", "name": "Skrlth", "picture": { "data": { "url": "https://scontent.fbga2-1.fna.fbcdn.net/v/t39.30808-1/274301226_620920095828753_1140218923250901113_n.jpg?stp=c358.0.924.924a_cp0_dst-jpg_s50x50_tt6&_nc_cat=108&ccb=1-7&_nc_sid=fe756c&_nc_ohc=OkDsoqbUHSUQ7kNvgGABr4V&_nc_zt=24&_nc_ht=scontent.fbga2-1.fna&edm=AGaHXAAEAAAA&_nc_gid=A6fDpX2vyGw-0ZenGdZiMv_&oh=00_AYA-ndeFAjMkuD5zsorxd7jSA6eR4f4uzVAYPfD73YDNcQ&oe=677A3C95" } }, "category": "Músico/grupo de música", "access_token": "token", "followers_count": 1493 }, "facebook_pixel": null, "instagram_page": { "id": "igPage", "name": "Skrlth", "businessAccount": { "id": "pageID", "username": "skrlth_cln", "followers_count": 1926, "profile_picture_url": "https://scontent.fbga2-1.fna.fbcdn.net/v/t51.2885-15/80430551_1079322795741032_1637145016730124288_n.jpg?_nc_cat=107&ccb=1-7&_nc_sid=7d201b&_nc_ohc=VAFnV1DgyLAQ7kNvgGJ5aun&_nc_zt=23&_nc_ht=scontent.fbga2-1.fna&edm=AJdBtusEAAAA&oh=00_AYDs1WlBixvcIuV3AhL5AcdlcvVMk-fEjI4lK8iH2SY9aA&oe=677A0EE6" }, "instagramAccount": { "id": "igPage", "username": "skrlth_cln", "is_private": false, "profile_pic": "https://scontent.fcul2-1.fna.fbcdn.net/v/t51.2885-15/80430551_1079322795741032_1637145016730124288_n.jpg?_nc_cat=107&ccb=1-7&_nc_sid=7d201b&_nc_ohc=Nx_S2CcOizQQ7kNvgERlyCu&_nc_zt=23&_nc_ht=scontent.fcul2-1.fna&edm=AAIyh0EEAAAA&oh=00_AYAPLBe_KIKrbp41vcnPyHlQe_tpxzvHbFOUltnvhff9vg&oe=6790E8E6", "follow_count": 48, "is_published": true, "followed_by_count": 1926 }, "connected_instagram_account": { "id": "pageID", "username": "skrlth_cln", "followers_count": 1926, "profile_picture_url": "https://scontent.fcul2-1.fna.fbcdn.net/v/t51.2885-15/80430551_1079322795741032_1637145016730124288_n.jpg?_nc_cat=107&ccb=1-7&_nc_sid=7d201b&_nc_ohc=Nx_S2CcOizQQ7kNvgERlyCu&_nc_zt=23&_nc_ht=scontent.fcul2-1.fna&edm=AAIyh0EEAAAA&oh=00_AYAPLBe_KIKrbp41vcnPyHlQe_tpxzvHbFOUltnvhff9vg&oe=6790E8E6" } }, "youtube_channel": { "id": "channelId", "etag": "tag", "kind": "youtube#searchResult", "snippet": { "title": "Skarleth CLN", "channelId": "channelId", "thumbnails": { "high": { "url": "https://yt3.ggpht.com/osHR2uBpd_PRxthXbnhGi7725-Kz9nhJBggZkXRGYgEpjqHUm8cZh98JpBfFa-cW0UHLrL82Pg=s800-c-k-c0xffffffff-no-rj-mo" }, "medium": { "url": "https://yt3.ggpht.com/osHR2uBpd_PRxthXbnhGi7725-Kz9nhJBggZkXRGYgEpjqHUm8cZh98JpBfFa-cW0UHLrL82Pg=s240-c-k-c0xffffffff-no-rj-mo" }, "default": { "url": "https://yt3.ggpht.com/osHR2uBpd_PRxthXbnhGi7725-Kz9nhJBggZkXRGYgEpjqHUm8cZh98JpBfFa-cW0UHLrL82Pg=s88-c-k-c0xffffffff-no-rj-mo" } }, "description": "Canal oficial de la banda culichi ...Skarleth...", "publishTime": "2012-11-03T05:16:40Z", "publishedAt": "2012-11-03T05:16:40Z", "channelTitle": "Skarleth CLN", "liveBroadcastContent": "none" } }, "google_analytics": "G-SPNB69X0DM", "logged_in_fb_user": { "id": "userID", "name": "Miguel González", "picture": { "data": { "url": "https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=userID&height=50&width=50&ext=1738416003&hash=AbZeDTAZjm9hhgDNvUENpJQh" } }, "expires_at": null, "access_token": "token", "fbTokenValid": true }, "facebook_ad_account": { "id": "accountID", "name": "Vendora", "business": { "id": "395494001069607", "name": "Vendify" }, "currency": "MXN", "user_tasks": [ "DRAFT", "ANALYZE", "ADVERTISE", "MANAGE" ], "amount_spent": 5050.24, "userHasAccess": true, "account_status": 1 }, "spotify_artist_page": { "id": "5fX7wIWuzZFWQbm25ccU3t", "uri": "spotify:artist:5fX7wIWuzZFWQbm25ccU3t", "href": "https://api.spotify.com/v1/artists/5fX7wIWuzZFWQbm25ccU3t", "name": "Skrlth", "type": "artist", "genres": [], "images": [ { "url": "https://i.scdn.co/image/ab6761610000e5ebb23a44c0a1dced197a02dbaf", "width": 640, "height": 640 }, { "url": "https://i.scdn.co/image/ab67616100005174b23a44c0a1dced197a02dbaf", "width": 320, "height": 320 }, { "url": "https://i.scdn.co/image/ab6761610000f178b23a44c0a1dced197a02dbaf", "width": 160, "height": 160 } ], "followers": { "href": null, "total": 87 }, "popularity": 0, "external_urls": { "spotify": "https://open.spotify.com/artist/5fX7wIWuzZFWQbm25ccU3t" } }, "soundcloud_artist_page": { "url": "https://soundcloud.com/skarleth-4", "username": "skarleth-4" }, "facebook_business_manager": null, "business_discovery_instagram": null, "facebook_pixel_conversions_domain": null, "facebook_pixel_conversions_api_access_token": null }, "hideFansTab": false, "subscription": { "tier": "pro", "type": "organic", "status": "active", "is_trial": false, "setup_by": null, "onOldPlan": false, "trial_ends": null, "referral_id": null, "freeTrialOver": true, "payment_method": "stripe", "checkout_source": "Desktop Navigation - Upgrade to Pro Button", "stripe_session_id": "sessionID", "recurring_interval": "monthly", "stripe_customer_id": "customerID", "checking_out_user_id": 256, "first_conversion_made": false, "stripe_subscription_id": "subscriptionId", "saved_as_tapfiliate_customer": null, "saved_as_tapfiliate_conversion": null, "subscription_scheduled_end_date": "2024-06-23T11:14:20-06:00", "monthly_seats_subscription_item_id": "subscriptionId", "monthly_campaigns_spent_subscription_item_id": "subscriptionId" }, "freeTrialOver": true, "permissionLevel": null, "affiliate_details": null, "conversionsStatus": null, "stripe_customer_id": "customerID", "content_initialized": true, "showRecommendations": false, "reauthenticateFbUser": false, "dashboard_initialized": true }, "assets": { "all": [ { "url": "https://scontent-ord5-2.xx.fbcdn.net/v/t45.1600-4/476444813_6740722863286_5298702721919651348_n.jpg?_nc_cat=103&ccb=1-7&_nc_sid=890911&_nc_ohc=LfKEIubsAocQ7kNvgFGr_AO&_nc_oc=Adh0T2_M085OU4FmkrAXaRnrsvFGHzv1XVfjY6tVRjqxUW7zntc34l2P7tuQf0kkNyA&_nc_zt=1&_nc_ht=scontent-ord5-2.xx&edm=AJNyvH4EAAAA&_nc_gid=AaKUTTjiFq0IQlI4yfXKNDY&oh=00_AYCa1u54eR9Kp8yHROliiGFvDhVDuT-CkaoM4cC5SsqeGA&oe=67BD5531", "name": "sunflower.jpg", "type": "image", "fb_id": "02fdb8effcac18c06ca00f946781b6d5", "width": 600, "height": 400, "thumbnail": "https://scontent-ord5-2.xx.fbcdn.net/v/t45.1600-4/476444813_6740722863286_5298702721919651348_n.jpg?stp=dst-jpg_p168x128_tt6&_nc_cat=103&ccb=1-7&_nc_sid=189157&_nc_ohc=LfKEIubsAocQ7kNvgFGr_AO&_nc_oc=Adh0T2_M085OU4FmkrAXaRnrsvFGHzv1XVfjY6tVRjqxUW7zntc34l2P7tuQf0kkNyA&_nc_zt=1&_nc_ht=scontent-ord5-2.xx&edm=AJNyvH4EAAAA&_nc_gid=AaKUTTjiFq0IQlI4yfXKNDY&oh=00_AYBn2KUXLwsfykj0zZpu4piWnLUBzVo90hCUPph_OJJG3g&oe=67BD5531", "formatType": "feed" } ] }, "budget": 550, "fbPage": { "id": "pageID", "name": "Skrlth", "picture": { "data": { "url": "https://scontent-ord5-2.xx.fbcdn.net/v/t39.30808-1/274301226_620920095828753_1140218923250901113_n.jpg?stp=c358.0.924.924a_cp0_dst-jpg_s50x50_tt6&_nc_cat=108&ccb=1-7&_nc_sid=fe756c&_nc_ohc=b8Wvw-EdXaYQ7kNvgGvTw57&_nc_oc=Adivkee7UUA2we1WbA_a9-3u2hdQ2SBSy-szIjt47QdWFwqkn9okaslvJ4hSsSY2C_I&_nc_zt=24&_nc_ht=scontent-ord5-2.xx&edm=AJdBtusEAAAA&_nc_gid=AvNmtTSM_K4SjRfF_bKXqKk&oh=00_AYCr0uPYbZOAj9HHLyGqapYBI_Li4WL10weVRC8lguIN4A&oe=67BD7915" } }, "category": "Músico/grupo de música", "access_token": "token", "is_published": true, "followers_count": 1492, "instagram_business_account": { "id": "pageID", "username": "skrlth_cln", "followers_count": 1913, "profile_picture_url": "https://scontent-ord5-2.xx.fbcdn.net/v/t51.2885-15/80430551_1079322795741032_1637145016730124288_n.jpg?_nc_cat=107&ccb=1-7&_nc_sid=7d201b&_nc_ohc=tjRX0QB0Lz8Q7kNvgF4ps4c&_nc_oc=AdhozTsMkYbcnbHvF8bfc-mYMNe5vg7vu4GSpHFsolVzL1dQkLrZTQmU7EV_gM7SB7I&_nc_zt=23&_nc_ht=scontent-ord5-2.xx&edm=AJdBtusEAAAA&oh=00_AYA92HKhXdEDZ2oeW9xWfU-WbKzpz0svXWltqkFnXmKaKw&oe=67BD4B66" }, "connected_instagram_account": { "id": "pageID", "username": "skrlth_cln", "followers_count": 1913, "profile_picture_url": "https://scontent-ord5-2.xx.fbcdn.net/v/t51.2885-15/80430551_1079322795741032_1637145016730124288_n.jpg?_nc_cat=107&ccb=1-7&_nc_sid=7d201b&_nc_ohc=tjRX0QB0Lz8Q7kNvgF4ps4c&_nc_oc=AdhozTsMkYbcnbHvF8bfc-mYMNe5vg7vu4GSpHFsolVzL1dQkLrZTQmU7EV_gM7SB7I&_nc_zt=23&_nc_ht=scontent-ord5-2.xx&edm=AJdBtusEAAAA&oh=00_AYA92HKhXdEDZ2oeW9xWfU-WbKzpz0svXWltqkFnXmKaKw&oe=67BD4B66" } }, "igPage": { "businessAccount": { "id": "pageID", "username": "skrlth_cln", "followers_count": 1913, "profile_picture_url": "https://scontent-ord5-2.xx.fbcdn.net/v/t51.2885-15/80430551_1079322795741032_1637145016730124288_n.jpg?_nc_cat=107&ccb=1-7&_nc_sid=7d201b&_nc_ohc=tjRX0QB0Lz8Q7kNvgF4ps4c&_nc_oc=AdhozTsMkYbcnbHvF8bfc-mYMNe5vg7vu4GSpHFsolVzL1dQkLrZTQmU7EV_gM7SB7I&_nc_zt=23&_nc_ht=scontent-ord5-2.xx&edm=AJdBtusEAAAA&oh=00_AYA92HKhXdEDZ2oeW9xWfU-WbKzpz0svXWltqkFnXmKaKw&oe=67BD4B66" }, "instagramAccount": { "id": "igPage", "username": "skrlth_cln", "is_private": false, "profile_pic": "https://scontent-ord5-2.xx.fbcdn.net/v/t51.2885-15/80430551_1079322795741032_1637145016730124288_n.jpg?_nc_cat=107&ccb=1-7&_nc_sid=7d201b&_nc_ohc=tjRX0QB0Lz8Q7kNvgF4ps4c&_nc_oc=AdhozTsMkYbcnbHvF8bfc-mYMNe5vg7vu4GSpHFsolVzL1dQkLrZTQmU7EV_gM7SB7I&_nc_zt=23&_nc_ht=scontent-ord5-2.xx&edm=AOV4angEAAAA&oh=00_AYAP9atKEFZg5M1jgceFQN-Hw5KIBIYqAZvWgEgmxlsuGg&oe=67BD4B66", "follow_count": 49, "is_published": true, "followed_by_count": 1913 }, "connected_instagram_account": { "id": "pageID", "username": "skrlth_cln", "followers_count": 1913, "profile_picture_url": "https://scontent-ord5-2.xx.fbcdn.net/v/t51.2885-15/80430551_1079322795741032_1637145016730124288_n.jpg?_nc_cat=107&ccb=1-7&_nc_sid=7d201b&_nc_ohc=tjRX0QB0Lz8Q7kNvgF4ps4c&_nc_oc=AdhozTsMkYbcnbHvF8bfc-mYMNe5vg7vu4GSpHFsolVzL1dQkLrZTQmU7EV_gM7SB7I&_nc_zt=23&_nc_ht=scontent-ord5-2.xx&edm=AJdBtusEAAAA&oh=00_AYA92HKhXdEDZ2oeW9xWfU-WbKzpz0svXWltqkFnXmKaKw&oe=67BD4B66" } }, "record": { "name": "Traidores", "slug": "traidores", "type": "record", "explicit": true, "record_url": "https://open.spotify.com/track/7teUTYcXcZykRKN3Cve0L4", "spotify_id": "7teUTYcXcZykRKN3Cve0L4", "preview_url": "https://p.scdn.co/mp3-preview/1042c290dc95da9c1282d6b991123325156a2f69?cid=49052dc97dc9477e8e0b4aac9639e1ec", "spotify_uri": "spotify:track:7teUTYcXcZykRKN3Cve0L4", "external_ids": { "isrc": "QZFZ32084517" }, "release_date": "2017-10-30", "thumbnail_url": "https://i.scdn.co/image/ab67616d0000b273f5c9e3c13e1b034879eed353", "external_links": [ { "url": "https://music.amazon.com/albums/B084ZTMNW3?trackAsin=B084ZT69MQ", "name": "amazon_music" }, { "url": "https://amazon.com/dp/B084ZT69MQ", "name": "amazonStore" }, { "url": "https://play.anghami.com/song/69307118?refer=linktree", "name": "anghami" }, { "url": "https://www.deezer.com/track/883237392", "name": "deezer" }, { "url": "https://geo.music.apple.com/album/_/1499831545?i=1499831554&app=music&at=1000lHKX&ct=api_http&itscg=30200&itsct=odsl_m", "name": "apple_music" }, { "url": "https://napster.com/track/tra.445969354", "name": "napster" }, { "url": "https://tidal.com/track/132000525", "name": "tidal" }, { "url": "https://www.youtube.com/watch?v=VR7UAq6OoTs", "name": "youtube" }, { "url": "https://open.spotify.com/track/7teUTYcXcZykRKN3Cve0L4", "name": "spotify" }, { "url": "https://www.shazam.com/track/521143886/traidores", "name": "shazam" } ], "primary_artist": "Skrlth", "spotify_release_type": "Single" }, "endDate": "2025-05-20T15:00:00.000Z", "igMedia": null, "captions": { "all": "Traidores out now on all streaming services" }, "startDate": "2025-05-20T05:00:00.000Z", "price_data": { "name": "550 FB/IG Ads Campaign for \"Skrlth\"", "price": 550, "description": "\"Skrlth\" (Increase Music Streams)" }, "fbAdAccount": { "id": "accountID", "name": "Vendora", "business": { "id": "395494001069607", "name": "Vendify" }, "currency": "MXN", "user_tasks": [ "DRAFT", "ANALYZE", "ADVERTISE", "MANAGE" ], "amount_spent": "315975", "account_status": 1 }, "campaignName": "stripe test 20-02-2025 part 1", "conversionsDomain": "symphony.to", "targetedCountries": [ { "name": "High Engagement Markets", "budget": 1, "locations": [ { "type": "country", "label": "Australia", "value": "AU", "region_id": null, "country_code": null }, { "type": "country", "label": "Canada", "value": "CA", "region_id": null, "country_code": null }, { "type": "country", "label": "Germany", "value": "DE", "region_id": null, "country_code": null }, { "type": "country", "label": "France", "value": "FR", "region_id": null, "country_code": null }, { "type": "country", "label": "United Kingdom", "value": "GB", "region_id": null, "country_code": null }, { "type": "country", "label": "New Zealand", "value": "NZ", "region_id": null, "country_code": null }, { "type": "country", "label": "United States of America", "value": "US", "region_id": null, "country_code": null } ] } ], "conversionsEnabled": false, "conversionsEventName": "StreamingLinkClicked", "targetingDemographics": { "age": { "max": 28, "min": 18 }, "gender": "All", "languages": [ { "key": 6, "name": "English (US)", "selected": true }, { "key": 24, "name": "English (UK)", "selected": true } ] }, "userExistingAudiences": null, "interestTargetingAudiences": [ { "fbId": "6003020834693", "name": "Music" }, { "fbId": "6003029869785", "name": "Arts and music" } ] }, "campaign_state": { "brand": { "id": 246, "name": "Skrlth", "slug": "skrlth-test", "tier": "pro", "image": "https://i.scdn.co/image/ab6761610000e5ebb23a44c0a1dced197a02dbaf", "website": { "bgType": "artwork", "bgColor": "#000", "titleText": null, "socialIcons": [ { "key": "0", "url": "", "width": "25", "height": "25", "enabled": true, "rounded": true, "placeholder": "Facebook profile URL", "backgroundColor": "" }, { "key": "1", "url": "", "width": "25", "height": "25", "enabled": true, "rounded": true, "placeholder": "Instagram profile URL", "backgroundColor": "" }, { "key": "2", "url": "", "width": "25", "height": "25", "enabled": true, "rounded": true, "placeholder": "TikTok profile URL", "backgroundColor": "" }, { "key": "3", "url": "", "width": "25", "height": "25", "enabled": true, "rounded": true, "placeholder": "X profile URL", "backgroundColor": "" }, { "key": "4", "url": "", "width": "25", "height": "25", "enabled": true, "rounded": true, "placeholder": "YouTube profile URL", "backgroundColor": "" } ], "buttonConfig": "stacked", "primaryColor": "#7C18F7", "secondaryColor": "#000000", "enableSocialIcons": true, "removeSymphonyBrand": false, "addAffiliateLinkToLogo": true }, "currency": { "code": "MXN", "symbol": "$" }, "createdAt": "2022-03-25T00:11:31.220Z", "updatedAt": "2025-02-20T16:20:29.712Z", "connections": { "tiktok": { "url": "https://tiktok.com/@skrlth.cln", "username": "skrlth.cln" }, "audiomack": { "id": 31519512, "name": "JAY Z", "genres": [ "rap" ], "url_slug": "jay-z", "followers": 71467, "thumbnail_url": "https://assets.audiomack.com/jay-z/e8f9f8e6cd1a2fc9ab91af864ef88239b136863cce159f01f6907661da4ddde6.jpeg" }, "chartmetric": { "id": 5919680 }, "facebook_page": { "id": "pageID", "name": "Skrlth", "picture": { "data": { "url": "https://scontent.fbga2-1.fna.fbcdn.net/v/t39.30808-1/274301226_620920095828753_1140218923250901113_n.jpg?stp=c358.0.924.924a_cp0_dst-jpg_s50x50_tt6&_nc_cat=108&ccb=1-7&_nc_sid=fe756c&_nc_ohc=OkDsoqbUHSUQ7kNvgGABr4V&_nc_zt=24&_nc_ht=scontent.fbga2-1.fna&edm=AGaHXAAEAAAA&_nc_gid=A6fDpX2vyGw-0ZenGdZiMv_&oh=00_AYA-ndeFAjMkuD5zsorxd7jSA6eR4f4uzVAYPfD73YDNcQ&oe=677A3C95" } }, "category": "Músico/grupo de música", "access_token": "token", "followers_count": 1493 }, "facebook_pixel": null, "instagram_page": { "id": "igPage", "name": "Skrlth", "businessAccount": { "id": "pageID", "username": "skrlth_cln", "followers_count": 1926, "profile_picture_url": "https://scontent.fbga2-1.fna.fbcdn.net/v/t51.2885-15/80430551_1079322795741032_1637145016730124288_n.jpg?_nc_cat=107&ccb=1-7&_nc_sid=7d201b&_nc_ohc=VAFnV1DgyLAQ7kNvgGJ5aun&_nc_zt=23&_nc_ht=scontent.fbga2-1.fna&edm=AJdBtusEAAAA&oh=00_AYDs1WlBixvcIuV3AhL5AcdlcvVMk-fEjI4lK8iH2SY9aA&oe=677A0EE6" }, "instagramAccount": { "id": "igPage", "username": "skrlth_cln", "is_private": false, "profile_pic": "https://scontent.fcul2-1.fna.fbcdn.net/v/t51.2885-15/80430551_1079322795741032_1637145016730124288_n.jpg?_nc_cat=107&ccb=1-7&_nc_sid=7d201b&_nc_ohc=Nx_S2CcOizQQ7kNvgERlyCu&_nc_zt=23&_nc_ht=scontent.fcul2-1.fna&edm=AAIyh0EEAAAA&oh=00_AYAPLBe_KIKrbp41vcnPyHlQe_tpxzvHbFOUltnvhff9vg&oe=6790E8E6", "follow_count": 48, "is_published": true, "followed_by_count": 1926 }, "connected_instagram_account": { "id": "pageID", "username": "skrlth_cln", "followers_count": 1926, "profile_picture_url": "https://scontent.fcul2-1.fna.fbcdn.net/v/t51.2885-15/80430551_1079322795741032_1637145016730124288_n.jpg?_nc_cat=107&ccb=1-7&_nc_sid=7d201b&_nc_ohc=Nx_S2CcOizQQ7kNvgERlyCu&_nc_zt=23&_nc_ht=scontent.fcul2-1.fna&edm=AAIyh0EEAAAA&oh=00_AYAPLBe_KIKrbp41vcnPyHlQe_tpxzvHbFOUltnvhff9vg&oe=6790E8E6" } }, "youtube_channel": { "id": "channelId", "etag": "tag", "kind": "youtube#searchResult", "snippet": { "title": "Skarleth CLN", "channelId": "channelId", "thumbnails": { "high": { "url": "https://yt3.ggpht.com/osHR2uBpd_PRxthXbnhGi7725-Kz9nhJBggZkXRGYgEpjqHUm8cZh98JpBfFa-cW0UHLrL82Pg=s800-c-k-c0xffffffff-no-rj-mo" }, "medium": { "url": "https://yt3.ggpht.com/osHR2uBpd_PRxthXbnhGi7725-Kz9nhJBggZkXRGYgEpjqHUm8cZh98JpBfFa-cW0UHLrL82Pg=s240-c-k-c0xffffffff-no-rj-mo" }, "default": { "url": "https://yt3.ggpht.com/osHR2uBpd_PRxthXbnhGi7725-Kz9nhJBggZkXRGYgEpjqHUm8cZh98JpBfFa-cW0UHLrL82Pg=s88-c-k-c0xffffffff-no-rj-mo" } }, "description": "Canal oficial de la banda culichi ...Skarleth...", "publishTime": "2012-11-03T05:16:40Z", "publishedAt": "2012-11-03T05:16:40Z", "channelTitle": "Skarleth CLN", "liveBroadcastContent": "none" } }, "google_analytics": "G-SPNB69X0DM", "logged_in_fb_user": { "id": "userID", "name": "Miguel González", "picture": { "data": { "url": "https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=userID&height=50&width=50&ext=1738416003&hash=AbZeDTAZjm9hhgDNvUENpJQh" } }, "expires_at": null, "access_token": "token", "fbTokenValid": true }, "facebook_ad_account": { "id": "accountID", "name": "Vendora", "business": { "id": "395494001069607", "name": "Vendify" }, "currency": "MXN", "user_tasks": [ "DRAFT", "ANALYZE", "ADVERTISE", "MANAGE" ], "amount_spent": 5050.24, "userHasAccess": true, "account_status": 1 }, "spotify_artist_page": { "id": "5fX7wIWuzZFWQbm25ccU3t", "uri": "spotify:artist:5fX7wIWuzZFWQbm25ccU3t", "href": "https://api.spotify.com/v1/artists/5fX7wIWuzZFWQbm25ccU3t", "name": "Skrlth", "type": "artist", "genres": [], "images": [ { "url": "https://i.scdn.co/image/ab6761610000e5ebb23a44c0a1dced197a02dbaf", "width": 640, "height": 640 }, { "url": "https://i.scdn.co/image/ab67616100005174b23a44c0a1dced197a02dbaf", "width": 320, "height": 320 }, { "url": "https://i.scdn.co/image/ab6761610000f178b23a44c0a1dced197a02dbaf", "width": 160, "height": 160 } ], "followers": { "href": null, "total": 87 }, "popularity": 0, "external_urls": { "spotify": "https://open.spotify.com/artist/5fX7wIWuzZFWQbm25ccU3t" } }, "soundcloud_artist_page": { "url": "https://soundcloud.com/skarleth-4", "username": "skarleth-4" }, "facebook_business_manager": null, "business_discovery_instagram": null, "facebook_pixel_conversions_domain": null, "facebook_pixel_conversions_api_access_token": null }, "hideFansTab": false, "subscription": { "tier": "pro", "type": "organic", "status": "active", "is_trial": false, "setup_by": null, "onOldPlan": false, "trial_ends": null, "referral_id": null, "freeTrialOver": true, "payment_method": "stripe", "checkout_source": "Desktop Navigation - Upgrade to Pro Button", "stripe_session_id": "sessionID", "recurring_interval": "monthly", "stripe_customer_id": "customerID", "checking_out_user_id": 256, "first_conversion_made": false, "stripe_subscription_id": "subscriptionId", "saved_as_tapfiliate_customer": null, "saved_as_tapfiliate_conversion": null, "subscription_scheduled_end_date": "2024-06-23T11:14:20-06:00", "monthly_seats_subscription_item_id": "subscriptionId", "monthly_campaigns_spent_subscription_item_id": "subscriptionId" }, "freeTrialOver": true, "permissionLevel": null, "affiliate_details": null, "conversionsStatus": null, "stripe_customer_id": "customerID", "content_initialized": true, "showRecommendations": false, "reauthenticateFbUser": false, "dashboard_initialized": true }, "record": { "name": "Traidores", "slug": "traidores", "type": "record", "explicit": true, "record_url": "https://open.spotify.com/track/7teUTYcXcZykRKN3Cve0L4", "spotify_id": "7teUTYcXcZykRKN3Cve0L4", "preview_url": "https://p.scdn.co/mp3-preview/1042c290dc95da9c1282d6b991123325156a2f69?cid=49052dc97dc9477e8e0b4aac9639e1ec", "spotify_uri": "spotify:track:7teUTYcXcZykRKN3Cve0L4", "external_ids": { "isrc": "QZFZ32084517" }, "release_date": "2017-10-30", "thumbnail_url": "https://i.scdn.co/image/ab67616d0000b273f5c9e3c13e1b034879eed353", "external_links": [ { "url": "https://music.amazon.com/albums/B084ZTMNW3?trackAsin=B084ZT69MQ", "name": "amazon_music" }, { "url": "https://amazon.com/dp/B084ZT69MQ", "name": "amazonStore" }, { "url": "https://play.anghami.com/song/69307118?refer=linktree", "name": "anghami" }, { "url": "https://www.deezer.com/track/883237392", "name": "deezer" }, { "url": "https://geo.music.apple.com/album/_/1499831545?i=1499831554&app=music&at=1000lHKX&ct=api_http&itscg=30200&itsct=odsl_m", "name": "apple_music" }, { "url": "https://napster.com/track/tra.445969354", "name": "napster" }, { "url": "https://tidal.com/track/132000525", "name": "tidal" }, { "url": "https://www.youtube.com/watch?v=VR7UAq6OoTs", "name": "youtube" }, { "url": "https://open.spotify.com/track/7teUTYcXcZykRKN3Cve0L4", "name": "spotify" }, { "url": "https://www.shazam.com/track/521143886/traidores", "name": "shazam" } ], "primary_artist": "Skrlth", "spotify_release_type": "Single" }, "accounts": { "fbPage": { "id": "pageID", "name": "Skrlth", "picture": { "data": { "url": "https://scontent-ord5-2.xx.fbcdn.net/v/t39.30808-1/274301226_620920095828753_1140218923250901113_n.jpg?stp=c358.0.924.924a_cp0_dst-jpg_s50x50_tt6&_nc_cat=108&ccb=1-7&_nc_sid=fe756c&_nc_ohc=b8Wvw-EdXaYQ7kNvgGvTw57&_nc_oc=Adivkee7UUA2we1WbA_a9-3u2hdQ2SBSy-szIjt47QdWFwqkn9okaslvJ4hSsSY2C_I&_nc_zt=24&_nc_ht=scontent-ord5-2.xx&edm=AJdBtusEAAAA&_nc_gid=AvNmtTSM_K4SjRfF_bKXqKk&oh=00_AYCr0uPYbZOAj9HHLyGqapYBI_Li4WL10weVRC8lguIN4A&oe=67BD7915" } }, "category": "Músico/grupo de música", "access_token": "token", "is_published": true, "followers_count": 1492, "instagram_business_account": { "id": "pageID", "username": "skrlth_cln", "followers_count": 1913, "profile_picture_url": "https://scontent-ord5-2.xx.fbcdn.net/v/t51.2885-15/80430551_1079322795741032_1637145016730124288_n.jpg?_nc_cat=107&ccb=1-7&_nc_sid=7d201b&_nc_ohc=tjRX0QB0Lz8Q7kNvgF4ps4c&_nc_oc=AdhozTsMkYbcnbHvF8bfc-mYMNe5vg7vu4GSpHFsolVzL1dQkLrZTQmU7EV_gM7SB7I&_nc_zt=23&_nc_ht=scontent-ord5-2.xx&edm=AJdBtusEAAAA&oh=00_AYA92HKhXdEDZ2oeW9xWfU-WbKzpz0svXWltqkFnXmKaKw&oe=67BD4B66" }, "connected_instagram_account": { "id": "pageID", "username": "skrlth_cln", "followers_count": 1913, "profile_picture_url": "https://scontent-ord5-2.xx.fbcdn.net/v/t51.2885-15/80430551_1079322795741032_1637145016730124288_n.jpg?_nc_cat=107&ccb=1-7&_nc_sid=7d201b&_nc_ohc=tjRX0QB0Lz8Q7kNvgF4ps4c&_nc_oc=AdhozTsMkYbcnbHvF8bfc-mYMNe5vg7vu4GSpHFsolVzL1dQkLrZTQmU7EV_gM7SB7I&_nc_zt=23&_nc_ht=scontent-ord5-2.xx&edm=AJdBtusEAAAA&oh=00_AYA92HKhXdEDZ2oeW9xWfU-WbKzpz0svXWltqkFnXmKaKw&oe=67BD4B66" } }, "igPage": { "businessAccount": { "id": "pageID", "username": "skrlth_cln", "followers_count": 1913, "profile_picture_url": "https://scontent-ord5-2.xx.fbcdn.net/v/t51.2885-15/80430551_1079322795741032_1637145016730124288_n.jpg?_nc_cat=107&ccb=1-7&_nc_sid=7d201b&_nc_ohc=tjRX0QB0Lz8Q7kNvgF4ps4c&_nc_oc=AdhozTsMkYbcnbHvF8bfc-mYMNe5vg7vu4GSpHFsolVzL1dQkLrZTQmU7EV_gM7SB7I&_nc_zt=23&_nc_ht=scontent-ord5-2.xx&edm=AJdBtusEAAAA&oh=00_AYA92HKhXdEDZ2oeW9xWfU-WbKzpz0svXWltqkFnXmKaKw&oe=67BD4B66" }, "instagramAccount": { "id": "igPage", "username": "skrlth_cln", "is_private": false, "profile_pic": "https://scontent-ord5-2.xx.fbcdn.net/v/t51.2885-15/80430551_1079322795741032_1637145016730124288_n.jpg?_nc_cat=107&ccb=1-7&_nc_sid=7d201b&_nc_ohc=tjRX0QB0Lz8Q7kNvgF4ps4c&_nc_oc=AdhozTsMkYbcnbHvF8bfc-mYMNe5vg7vu4GSpHFsolVzL1dQkLrZTQmU7EV_gM7SB7I&_nc_zt=23&_nc_ht=scontent-ord5-2.xx&edm=AOV4angEAAAA&oh=00_AYAP9atKEFZg5M1jgceFQN-Hw5KIBIYqAZvWgEgmxlsuGg&oe=67BD4B66", "follow_count": 49, "is_published": true, "followed_by_count": 1913 }, "connected_instagram_account": { "id": "pageID", "username": "skrlth_cln", "followers_count": 1913, "profile_picture_url": "https://scontent-ord5-2.xx.fbcdn.net/v/t51.2885-15/80430551_1079322795741032_1637145016730124288_n.jpg?_nc_cat=107&ccb=1-7&_nc_sid=7d201b&_nc_ohc=tjRX0QB0Lz8Q7kNvgF4ps4c&_nc_oc=AdhozTsMkYbcnbHvF8bfc-mYMNe5vg7vu4GSpHFsolVzL1dQkLrZTQmU7EV_gM7SB7I&_nc_zt=23&_nc_ht=scontent-ord5-2.xx&edm=AJdBtusEAAAA&oh=00_AYA92HKhXdEDZ2oeW9xWfU-WbKzpz0svXWltqkFnXmKaKw&oe=67BD4B66" } }, "fbAdAccount": { "id": "accountID", "name": "Vendora", "business": { "id": "395494001069607", "name": "Vendify" }, "currency": "MXN", "user_tasks": [ "DRAFT", "ANALYZE", "ADVERTISE", "MANAGE" ], "amount_spent": "315975", "account_status": 1 } }, "campaign": { "details": { "budget": 550, "endDate": "2025-05-20T15:00:00.000Z", "startDate": "2025-05-20T05:00:00.000Z" }, "creative": { "cta": null, "assets": { "all": [ { "url": "https://scontent-ord5-2.xx.fbcdn.net/v/t45.1600-4/476444813_6740722863286_5298702721919651348_n.jpg?_nc_cat=103&ccb=1-7&_nc_sid=890911&_nc_ohc=LfKEIubsAocQ7kNvgFGr_AO&_nc_oc=Adh0T2_M085OU4FmkrAXaRnrsvFGHzv1XVfjY6tVRjqxUW7zntc34l2P7tuQf0kkNyA&_nc_zt=1&_nc_ht=scontent-ord5-2.xx&edm=AJNyvH4EAAAA&_nc_gid=AaKUTTjiFq0IQlI4yfXKNDY&oh=00_AYCa1u54eR9Kp8yHROliiGFvDhVDuT-CkaoM4cC5SsqeGA&oe=67BD5531", "name": "sunflower.jpg", "type": "image", "fb_id": "02fdb8effcac18c06ca00f946781b6d5", "width": 600, "height": 400, "thumbnail": "https://scontent-ord5-2.xx.fbcdn.net/v/t45.1600-4/476444813_6740722863286_5298702721919651348_n.jpg?stp=dst-jpg_p168x128_tt6&_nc_cat=103&ccb=1-7&_nc_sid=189157&_nc_ohc=LfKEIubsAocQ7kNvgFGr_AO&_nc_oc=Adh0T2_M085OU4FmkrAXaRnrsvFGHzv1XVfjY6tVRjqxUW7zntc34l2P7tuQf0kkNyA&_nc_zt=1&_nc_ht=scontent-ord5-2.xx&edm=AJNyvH4EAAAA&_nc_gid=AaKUTTjiFq0IQlI4yfXKNDY&oh=00_AYBn2KUXLwsfykj0zZpu4piWnLUBzVo90hCUPph_OJJG3g&oe=67BD5531", "formatType": "feed" } ] }, "igMedia": null, "captions": { "all": "Traidores out now on all streaming services" }, "mainCaption": null }, "targeting": { "targetedCountries": [ { "name": "High Engagement Markets", "budget": 1, "locations": [ { "type": "country", "label": "Australia", "value": "AU", "region_id": null, "country_code": null }, { "type": "country", "label": "Canada", "value": "CA", "region_id": null, "country_code": null }, { "type": "country", "label": "Germany", "value": "DE", "region_id": null, "country_code": null }, { "type": "country", "label": "France", "value": "FR", "region_id": null, "country_code": null }, { "type": "country", "label": "United Kingdom", "value": "GB", "region_id": null, "country_code": null }, { "type": "country", "label": "New Zealand", "value": "NZ", "region_id": null, "country_code": null }, { "type": "country", "label": "United States of America", "value": "US", "region_id": null, "country_code": null } ] } ], "targetingDemographics": { "age": { "max": 28, "min": 18 }, "gender": "All", "languages": [ { "key": 6, "name": "English (US)", "selected": true }, { "key": 24, "name": "English (UK)", "selected": true } ] }, "interestTargetingAudiences": [ { "fbId": "6003020834693", "name": "Music" }, { "fbId": "6003029869785", "name": "Arts and music" } ] }, "conversions": { "conversionsDomain": "symphony.to", "conversionsEnabled": false, "conversionsEventName": "StreamingLinkClicked", "conversionsApiAccessToken": null } } }, "payment_details": null, "platform_details": { "ad_types": [ { "name": "all", "ad_ids": [ "6759736113486", "6759736112886" ] }, { "name": "spotify", "ad_ids": [] }, { "name": "apple_music", "ad_ids": [] }, { "name": "youtube", "ad_ids": [] }, { "name": "soundcloud", "ad_ids": [] }, { "name": "custom", "ad_ids": [] } ], "campaigns": [ "6759735593886" ], "ad_account": "accountID", "access_token": "token", "errorCampaigns": [], "campaignsMapping": [ { "name": "High Engagement Markets", "cities": [], "regions": [], "fraction": 1, "countries": [ "AU", "CA", "DE", "FR", "GB", "NZ", "US" ], "fbCampaign": { "id": "6759735593886", "error": null, "adsets": [], "fields": { "name": "[S - Dev] Traidores / High Engagement Markets / 05/20", "status": "PAUSED", "objective": "OUTCOME_TRAFFIC", "pacing_type": [ "standard" ], "bid_strategy": "LOWEST_COST_WITHOUT_CAP", "lifetime_budget": 55000, "special_ad_categories": "NONE" } }, "excluded_countries": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "GA", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "included_countries": [ "AU", "CA", "DE", "FR", "GB", "NZ", "US" ] } ], "creatives_mapping": [] }, "campaign_platforms": [ "fb" ] }, "createdAt": "2025-02-20T20:14:54.658Z", "updatedAt": "2025-02-20T20:15:12.923Z" }, "status": 200 }
3.2.2 Fetch Creative Performance Analytics
Endpoint: GET /advertising/v1/analytic/creative/performance
Description: Retrieve performance metrics for the creatives associated with a campaign.
Query Parameters:
campaignId: The unique ID of the campaign.
Request Example:
curl -X 'GET' \
'{{ADVERTISING_API}}/v1/analytic/creative/performance?campaignId=12345' \
-H 'accept: application/json' \
-H 'x-api-key: {{YOUR_API_KEY}}'Expected Response:
{
"data": [
"type": "reels",
"clicks": 0,
"percentage": 0
]
}3.2.3 Fetch Campaign-Level Analytics
Endpoint: GET /advertising/v1/analytic/campaign/{id}
Description: Retrieve high-level analytics for a specific campaign.
Request Example:
curl -X 'GET' \
'{{ADVERTISING_API}}/v1/analytic/campaign/12345' \
-H 'accept: application/json' \
-H 'x-api-key: {{YOUR_API_KEY}}'-
Expected Response:
{ "data": { "facebook_ad_media": { "media_url": "string", "owner": { "profile_pic": "string", "username": "string", "id": "string" } }, "analytic_data": { "adAccountStatus": { "good": true, "error": "Unknown Type: string,null" }, "campaignStatuses": [ { "effective_status": "string", "id": "string", "name": "string" } ], "adStatuses": [ { "effective_status": "string", "id": "string", "name": "string" } ], "campaignPerformanceStats": { "cost_per_inline_link_click": "string", "actions": [ { "action_type": "string", "value": "string" } ], "cpc": "string", "cpm": "string", "reach": "string", "impressions": "string", "spend": "string", "inline_link_clicks": "string", "clicks": "string", "cost_per_action_type": [ { "action_type": "string", "value": "string" } ], "date_start": "2025-01-25", "date_stop": "2025-01-25" }, "impactStats": [ { "name": "string", "data": "string", "friendlyName": "Unknown Type: string,null" } ], "dailyStats": [ { "date": "string", "totalSpend": 0, "totalReach": 0, "totalImpressions": 0, "totalClicks": 0, "clicks": "string", "inlineClicks": 0, "cpic": 0, "cpc": 0, "spend": 0, "costPerConversion": 0, "conversions": 0 } ], "geographicBreakdown": { "countries": [ { "country": "string", "countryName": "string", "cpc": 0, "reach": 0, "impressions": 0, "clicks": 0, "spend": 0 } ] } }, "creative_performance": [ { "type": "string", "clicks": 0, "percentage": 0 } ] }, "status": 200 }
Note:
All endpoints require the x-api-key in the headers for authentication. Additionally, if the campaign is associated with a specific user brand, include the x-brand-id header for accurate data retrieval.
3.3 Create Campaigns
To see campaign creation flow, see following resource:
3.4 Campaign Lifecycle Webhooks
Updated about 2 months ago