PPSPYAPI Platform
EN / 中文
API REFERENCE

Monitor Task Ad List API

POST/open-api/v1/ad-monitor-task/ad-library-list
·api.ppspy.com
Data and monitoring usage rules

Points Consumption Rules: 1. Retrieving a Shopify data result consumes 1 data, while retrieving an ad library data result consumes 2 data. Retrieving additional data details for a data result does not consume data. 2. Ad monitoring and sales monitoring: Each monitoring session costs $1/month. Each monitoring session is valid for one month and automatically expires after one month. Deleting a monitoring session does not restore the monitoring session, so please delete with caution. Monitoring sessions can be accessed at any time and are unlimited.

Request headers

AUTHORIZATIONAuthorization: {API Key}
CONTENT-TYPEapplication/json
ACCEPTapplication/json

Request example

cURL
curl --location --request POST 'https://api.ppspy.com/open-api/v1/ad-monitor-task/ad-library-list' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: {API Key}' \
--data-raw '{
    "task_id": "902175d02614903e4944dfdfe85bbb4d",
    "order_by": "ad_started_at",
    "direction": "desc",
    "page": 1,
    "per_page": 8
}'

Request parameters 33 fields

Pass each parameter in its specified location.

Parameter Type Description
body
body · optional
object | none
» task_id
body · required
string Monitor Task ID | none
» ad_content
body · optional
string Ad Content | none
» ad_audience_reach_start
body · optional
integer Audience Reach (Min) | none
» ad_audience_reach_end
body · optional
integer Audience Reach (Max) | none
» ad_cost_start
body · optional
number Ad Spend (Min) | Currency: USD
» ad_cost_end
body · optional
number Ad Spend (Max) | Currency: USD
» adset_count_start
body · optional
integer Ad Set Count (Min) | none
» adset_count_end
body · optional
integer Ad Set Count (Max) | none
» ad_forecast_list
body · optional
[integer] Ad Forecast | Options: 1-Testing Phase, 2-Growth Phase, 3-Profit Phase.
» media_format_list
body · optional
[integer] Media Format | Options: 1-Video, 2-Image, 3-Carousel.
» video_duration_start
body · optional
integer Video Duration (Min) | none
» video_duration_end
body · optional
integer Video Duration (Max) | none
» ad_started_at_start
body · optional
integer Ad Creation Time (Start) | Timestamp: seconds.
» ad_started_at_end
body · optional
integer Ad Creation Time (End) | Timestamp: seconds.
» latest_actived_at_start
body · optional
integer Ad Last Active Time (Start) | Timestamp: seconds.
» latest_actived_at_end
body · optional
integer Ad Last Active Time (End) | Timestamp: seconds.
» active_days_start
body · optional
integer Ad Duration (Min) | none
» active_days_end
body · optional
integer Ad Duration (Max) | none
» button_text_list
body · optional
[string] Ad Button Text | none
» ad_status_list
body · optional
[integer] Ad Status | Options: 1-Active, 2-Stopped, 3-Removed.
» related_product_id_list
body · optional
[string] Product ID | none
» product_price_usd_start
body · optional
number Product Price (Min) | Currency: USD
» product_price_usd_end
body · optional
number Product Price (Max) | Currency: USD
» product_creation_time_start
body · optional
integer Product Creation Time (Start) | Timestamp: seconds.
» product_creation_time_end
body · optional
integer Product Creation Time (End) | Timestamp: seconds.
» order_by
body · optional
string Sort Field | Options: ad_started_at-Ad Start Time, ad_ended_at-Ad End Time, active_days-Active Days, ad_cost-Ad Spend, ad_audience_reach-Audience Reach.
» direction
body · optional
string Sort Direction | Options: desc-Descending, asc-Ascending.
» page
body · optional
integer Page Number | none
» per_page
body · optional
integer Page Size | none
» keyword
body · optional
string Search Keyword | none
» landing_page
body · optional
string Landing Page URL | none
» ad_platform_list
body · required
[string] Ad Platform | Options: FACEBOOK, INSTAGRAM, AUDIENCE_NETWORK, MESSENGER, THREADS.

Response example

Response · JSON
{
    "code": 200,
    "message": "success",
    "data": {
        "current_page": 1,
        "data": [
            {
                "id": "881591547735275",
                "active_days": 1,
                "ad_audience": null,
                "ad_audience_reach": null,
                "ad_link": "https:\/\/www.facebook.com\/ads\/library\/?id=881591547735275",
                "ad_content": "Workwear just got a whole lot cuter, and EASIER 👏🏻 \n\nComment WANT for the link! \n\n#MidsizeStyle #MidsizeFashion #MidsizeOutfit #MidsizeWorkwear #WorkwearStyle #WorkwearFashion #OfficeOOTD #ChicAndComfy #OOTDInspo #StyleForAll #EverydayStyle #WorkwearLooks #MidsizeConfidence #RealisticStyle #BodyPositiveFashion #OfficeChic #MidsizeBabe #WearToWork #AffordableStyle #WorkwearWardrobe #bloomchic #bloomchicfashion",
                "ad_cost": null,
                "impression": null,
                "ad_cost_min": null,
                "ad_cost_max": null,
                "estimated_conversion_min": null,
                "estimated_conversion_max": null,
                "ad_forecast": 1,
                "ad_platform": [
                    "FACEBOOK",
                    "INSTAGRAM",
                    "AUDIENCE_NETWORK",
                    "MESSENGER",
                    "THREADS"
                ],
                "ad_started_at": 1761289200,
                "ad_ended_at": 1761289200,
                "ad_status": 1,
                "adset_count": 1,
                "advertiser": {
                    "id": "100842618611379",
                    "ad_count": 42579,
                    "ad_country": [],
                    "ads_library_link": "https:\/\/www.facebook.com\/ads\/library\/?active_status=active&ad_type=all&country=ALL&is_targeted_country=false&media_type=all&search_type=page&view_all_page_id=100842618611379",
                    "adset_count": null,
                    "like_count": 579749,
                    "name": "BloomChic",
                    "profile_picture_url": "https:\/\/cdn.pipidata.com\/images\/5b7079c262046251bde8e30f7e22f504.png",
                    "source_advertiser_id": "100842618611379",
                    "source_advertiser_link": null,
                    "e_commerce_platform": null
                },
                "button_type": "SHOP_NOW",
                "cards": null,
                "country": null,
                "first_discovered_at": 1761314043,
                "images": null,
                "landing_page_type": 2,
                "landing_pages": [
                    "https:\/\/bloomchic.com\/collections\/bloom-dress?sort_by=geometric-print-waist-cinched-tiered-midi-dress"
                ],
                "language": null,
                "last_discovered_at": 1761314043,
                "latest_actived_at": 1761289200,
                "media_format": 1,
                "ad_caption": "bloomchic.com",
                "ad_title": null,
                "ad_link_description": null,
                "button_text": "Shop now",
                "products": null,
                "source_ad_id": null,
                "store": {
                    "id": "f65b3d7c58eb2b3fe1a54854ccfbadc9",
                    "ad_count": 51299,
                    "logo_url": "http:\/\/bloomchic.com\/cdn\/shop\/files\/20240102-144940_32x32.png?v=1704178240",
                    "name": "BloomChic",
                    "source_store_link": "https:\/\/bloomchic.com",
                    "e_commerce_platform": "shopify",
                    "e_commerce_types": null
                },
                "videos": [
                    {
                        "cover_url": "https:\/\/cdn.pipidata.com\/images\/e330a7b0eb5c67ea9f7eb6645f31b758.png",
                        "duration": 45,
                        "height": 1280,
                        "url": "https:\/\/cdn.pipidata.com\/videos\/9bd5c12419cf03228dca988c0bf75822.mp4",
                        "width": 720
                    }
                ]
            },
            {
                "id": "870690415474321",
                "active_days": 1,
                "ad_audience": null,
                "ad_audience_reach": null,
                "ad_link": "https:\/\/www.facebook.com\/ads\/library\/?id=870690415474321",
                "ad_content": "🏖️ From size 10 to 30, every body deserves to shine! Our inclusive range of plus-size swimwear offers unbeatable prices without compromising on style or fit. Don't settle for less, dive into affordable luxury today!",
                "ad_cost": null,
                "impression": null,
                "ad_cost_min": null,
                "ad_cost_max": null,
                "estimated_conversion_min": null,
                "estimated_conversion_max": null,
                "ad_forecast": 1,
                "ad_platform": [
                    "FACEBOOK",
                    "INSTAGRAM",
                    "AUDIENCE_NETWORK",
                    "MESSENGER",
                    "THREADS"
                ],
                "ad_started_at": 1761289200,
                "ad_ended_at": 1761289200,
                "ad_status": 1,
                "adset_count": 2,
                "advertiser": {
                    "id": "100842618611379",
                    "ad_count": 42579,
                    "ad_country": [],
                    "ads_library_link": "https:\/\/www.facebook.com\/ads\/library\/?active_status=active&ad_type=all&country=ALL&is_targeted_country=false&media_type=all&search_type=page&view_all_page_id=100842618611379",
                    "adset_count": null,
                    "like_count": 579749,
                    "name": "BloomChic",
                    "profile_picture_url": "https:\/\/cdn.pipidata.com\/images\/5b7079c262046251bde8e30f7e22f504.png",
                    "source_advertiser_id": "100842618611379",
                    "source_advertiser_link": null,
                    "e_commerce_platform": null
                },
                "button_type": "SHOP_NOW",
                "cards": null,
                "country": null,
                "first_discovered_at": 1761289938,
                "images": null,
                "landing_page_type": 2,
                "landing_pages": [
                    "https:\/\/bloomchic.com\/collections\/swim?sort_by=twist-front-patchwork-adjustable-straps-swim-dress"
                ],
                "language": null,
                "last_discovered_at": 1761289938,
                "latest_actived_at": 1761289200,
                "media_format": 1,
                "ad_caption": "bloomchic.com",
                "ad_title": "SIZES 10 TO 30",
                "ad_link_description": null,
                "button_text": "Shop now",
                "products": null,
                "source_ad_id": null,
                "store": {
                    "id": "f65b3d7c58eb2b3fe1a54854ccfbadc9",
                    "ad_count": 51299,
                    "logo_url": "http:\/\/bloomchic.com\/cdn\/shop\/files\/20240102-144940_32x32.png?v=1704178240",
                    "name": "BloomChic",
                    "source_store_link": "https:\/\/bloomchic.com",
                    "e_commerce_platform": "shopify",
                    "e_commerce_types": null
                },
                "videos": [
                    {
                        "cover_url": "https:\/\/cdn.pipidata.com\/images\/c0b004574dc93c1da021351539de0767.png",
                        "duration": 19,
                        "height": 1280,
                        "url": "https:\/\/cdn.pipidata.com\/videos\/e16c991da80133054111c00eea8e3882.mp4",
                        "width": 720
                    }
                ]
            },
            {
                "id": "870647241954791",
                "active_days": 1,
                "ad_audience": null,
                "ad_audience_reach": null,
                "ad_link": "https:\/\/www.facebook.com\/ads\/library\/?id=870647241954791",
                "ad_content": "Sun, sand, and the perfect suit—this one’s got it all. With an adjustable back, wider shoulder straps for all-day ease, and tummy control that flatters in all the right places.",
                "ad_cost": null,
                "impression": null,
                "ad_cost_min": null,
                "ad_cost_max": null,
                "estimated_conversion_min": null,
                "estimated_conversion_max": null,
                "ad_forecast": 1,
                "ad_platform": [
                    "FACEBOOK",
                    "INSTAGRAM",
                    "AUDIENCE_NETWORK",
                    "MESSENGER",
                    "THREADS"
                ],
                "ad_started_at": 1761289200,
                "ad_ended_at": 1761289200,
                "ad_status": 1,
                "adset_count": 12,
                "advertiser": {
                    "id": "100842618611379",
                    "ad_count": 42579,
                    "ad_country": [],
                    "ads_library_link": "https:\/\/www.facebook.com\/ads\/library\/?active_status=active&ad_type=all&country=ALL&is_targeted_country=false&media_type=all&search_type=page&view_all_page_id=100842618611379",
                    "adset_count": null,
                    "like_count": 579749,
                    "name": "BloomChic",
                    "profile_picture_url": "https:\/\/cdn.pipidata.com\/images\/5b7079c262046251bde8e30f7e22f504.png",
                    "source_advertiser_id": "100842618611379",
                    "source_advertiser_link": null,
                    "e_commerce_platform": null
                },
                "button_type": "SHOP_NOW",
                "cards": null,
                "country": null,
                "first_discovered_at": 1761298420,
                "images": null,
                "landing_page_type": 2,
                "landing_pages": [
                    "https:\/\/bloomchic.com\/collections\/swim?sort_by=tropical-flower-print-pockets-one-piece-swimsuit"
                ],
                "language": null,
                "last_discovered_at": 1761298420,
                "latest_actived_at": 1761289200,
                "media_format": 1,
                "ad_caption": "bloomchic.com",
                "ad_title": "Perfect Suit for You",
                "ad_link_description": null,
                "button_text": "Shop now",
                "products": null,
                "source_ad_id": null,
                "store": {
                    "id": "f65b3d7c58eb2b3fe1a54854ccfbadc9",
                    "ad_count": 51299,
                    "logo_url": "http:\/\/bloomchic.com\/cdn\/shop\/files\/20240102-144940_32x32.png?v=1704178240",
                    "name": "BloomChic",
                    "source_store_link": "https:\/\/bloomchic.com",
                    "e_commerce_platform": "shopify",
                    "e_commerce_types": null
                },
                "videos": [
                    {
                        "cover_url": "https:\/\/cdn.pipidata.com\/images\/7d98498297a2bb5ccf8dff665311362a.png",
                        "duration": 16,
                        "height": 1280,
                        "url": "https:\/\/cdn.pipidata.com\/videos\/056020ab79a41dc8028ace666039c154.mp4",
                        "width": 720
                    }
                ]
            },
            {
                "id": "870121528780695",
                "active_days": 1,
                "ad_audience": null,
                "ad_audience_reach": null,
                "ad_link": "https:\/\/www.facebook.com\/ads\/library\/?id=870121528780695",
                "ad_content": "🏖️ From size 10 to 30, every body deserves to shine! Our inclusive range of plus-size swimwear offers unbeatable prices without compromising on style or fit. Don't settle for less, dive into affordable luxury today!",
                "ad_cost": null,
                "impression": null,
                "ad_cost_min": null,
                "ad_cost_max": null,
                "estimated_conversion_min": null,
                "estimated_conversion_max": null,
                "ad_forecast": 1,
                "ad_platform": [
                    "FACEBOOK",
                    "INSTAGRAM",
                    "AUDIENCE_NETWORK",
                    "MESSENGER",
                    "THREADS"
                ],
                "ad_started_at": 1761289200,
                "ad_ended_at": 1761289200,
                "ad_status": 1,
                "adset_count": 18,
                "advertiser": {
                    "id": "100842618611379",
                    "ad_count": 42579,
                    "ad_country": [],
                    "ads_library_link": "https:\/\/www.facebook.com\/ads\/library\/?active_status=active&ad_type=all&country=ALL&is_targeted_country=false&media_type=all&search_type=page&view_all_page_id=100842618611379",
                    "adset_count": null,
                    "like_count": 579749,
                    "name": "BloomChic",
                    "profile_picture_url": "https:\/\/cdn.pipidata.com\/images\/5b7079c262046251bde8e30f7e22f504.png",
                    "source_advertiser_id": "100842618611379",
                    "source_advertiser_link": null,
                    "e_commerce_platform": null
                },
                "button_type": "SHOP_NOW",
                "cards": null,
                "country": null,
                "first_discovered_at": 1761310633,
                "images": null,
                "landing_page_type": 2,
                "landing_pages": [
                    "https:\/\/bloomchic.com\/collections\/swim?sort_by=solid-keyhole-elastic-waist-gathered-one-piece-swimsuit"
                ],
                "language": null,
                "last_discovered_at": 1761310633,
                "latest_actived_at": 1761289200,
                "media_format": 1,
                "ad_caption": "bloomchic.com",
                "ad_title": "✨SIZES 10 TO 30✨",
                "ad_link_description": null,
                "button_text": "Shop now",
                "products": null,
                "source_ad_id": null,
                "store": {
                    "id": "f65b3d7c58eb2b3fe1a54854ccfbadc9",
                    "ad_count": 51299,
                    "logo_url": "http:\/\/bloomchic.com\/cdn\/shop\/files\/20240102-144940_32x32.png?v=1704178240",
                    "name": "BloomChic",
                    "source_store_link": "https:\/\/bloomchic.com",
                    "e_commerce_platform": "shopify",
                    "e_commerce_types": null
                },
                "videos": [
                    {
                        "cover_url": "https:\/\/cdn.pipidata.com\/images\/7c729064e26018c00bf8a0541640c81a.png",
                        "duration": 23,
                        "height": 1280,
                        "url": "https:\/\/cdn.pipidata.com\/videos\/b3f34ac3a0c7506fc178844c0c4b82c3.mp4",
                        "width": 720
                    }
                ]
            },
            {
                "id": "863124409614895",
                "active_days": 1,
                "ad_audience": null,
                "ad_audience_reach": null,
                "ad_link": "https:\/\/www.facebook.com\/ads\/library\/?id=863124409614895",
                "ad_content": "✨BloomChic | A Re-Imagining\nClothing for women sizes 10-30. We empower you with access to style, comfort, and choice.",
                "ad_cost": null,
                "impression": null,
                "ad_cost_min": null,
                "ad_cost_max": null,
                "estimated_conversion_min": null,
                "estimated_conversion_max": null,
                "ad_forecast": 1,
                "ad_platform": [
                    "FACEBOOK",
                    "INSTAGRAM",
                    "AUDIENCE_NETWORK",
                    "MESSENGER",
                    "THREADS"
                ],
                "ad_started_at": 1761289200,
                "ad_ended_at": 1761289200,
                "ad_status": 1,
                "adset_count": 1,
                "advertiser": {
                    "id": "100842618611379",
                    "ad_count": 42579,
                    "ad_country": [],
                    "ads_library_link": "https:\/\/www.facebook.com\/ads\/library\/?active_status=active&ad_type=all&country=ALL&is_targeted_country=false&media_type=all&search_type=page&view_all_page_id=100842618611379",
                    "adset_count": null,
                    "like_count": 579749,
                    "name": "BloomChic",
                    "profile_picture_url": "https:\/\/cdn.pipidata.com\/images\/5b7079c262046251bde8e30f7e22f504.png",
                    "source_advertiser_id": "100842618611379",
                    "source_advertiser_link": null,
                    "e_commerce_platform": null
                },
                "button_type": "SHOP_NOW",
                "cards": [
                    {
                        "cover_url": null,
                        "duration": null,
                        "height": 1200,
                        "media_type": 2,
                        "url": "https:\/\/cdn.pipidata.com\/images\/c4bc8b7b4d7d42396761328a519eef39.png",
                        "width": 1200
                    },
                    {
                        "cover_url": null,
                        "duration": null,
                        "height": 1200,
                        "media_type": 2,
                        "url": "https:\/\/cdn.pipidata.com\/images\/b5ffe55ff28c64e33a8348e1600cf356.png",
                        "width": 1200
                    },
                    {
                        "cover_url": null,
                        "duration": null,
                        "height": 1200,
                        "media_type": 2,
                        "url": "https:\/\/cdn.pipidata.com\/images\/b5ffe55ff28c64e33a8348e1600cf356.png",
                        "width": 1200
                    },
                    {
                        "cover_url": null,
                        "duration": null,
                        "height": 1200,
                        "media_type": 2,
                        "url": "https:\/\/cdn.pipidata.com\/images\/b5ffe55ff28c64e33a8348e1600cf356.png",
                        "width": 1200
                    },
                    {
                        "cover_url": null,
                        "duration": null,
                        "height": 1200,
                        "media_type": 2,
                        "url": "https:\/\/cdn.pipidata.com\/images\/b5ffe55ff28c64e33a8348e1600cf356.png",
                        "width": 1200
                    },
                    {
                        "cover_url": null,
                        "duration": null,
                        "height": 1200,
                        "media_type": 2,
                        "url": "https:\/\/cdn.pipidata.com\/images\/b5ffe55ff28c64e33a8348e1600cf356.png",
                        "width": 1200
                    }
                ],
                "country": null,
                "first_discovered_at": 1761303751,
                "images": null,
                "landing_page_type": 2,
                "landing_pages": [
                    "https:\/\/bloomchic.com\/products\/geometric-print-drawstring-skinny-waistline-inside-dress?variant=42774716711082&feed_id=fb4454701",
                    "https:\/\/bloomchic.com\/products\/geometric-print-drawstring-skinny-waistline-inside-dress?variant=42774716842154&feed_id=fb4454401",
                    "https:\/\/bloomchic.com\/products\/plunging-neck-button-detail-pocket-maxi-dress?variant=42759663648938&feed_id=fb9739801",
                    "https:\/\/bloomchic.com\/collections\/bloomchic-fit-label",
                    "https:\/\/bloomchic.com\/products\/geometric-print-drawstring-skinny-waistline-inside-dress?variant=42774716809386&feed_id=fb4454001",
                    "https:\/\/bloomchic.com\/products\/geometric-print-drawstring-skinny-waistline-inside-dress?variant=42774716743850&feed_id=fb4454601",
                    "https:\/\/bloomchic.com\/products\/geometric-print-drawstring-skinny-waistline-inside-dress?variant=42774716678314&feed_id=fb4454201"
                ],
                "language": null,
                "last_discovered_at": 1761303799,
                "latest_actived_at": 1761289200,
                "media_format": 3,
                "ad_caption": "bloomchic.com",
                "ad_title": "{{product.current_price strip_zeros}}|{{product.name}}",
                "ad_link_description": "",
                "button_text": "Shop now",
                "products": [
                    {
                        "id": "06f4503b3d07810ad2aec20b3eab46f2",
                        "ad_cost": null,
                        "ad_cost_ratio": null,
                        "ad_count": 653,
                        "ad_ended_at": 1761289200,
                        "ad_started_at": 1748502000,
                        "category_id": null,
                        "category_name": null,
                        "creation_time": 1648896600,
                        "currency": "USD",
                        "image_url": "https:\/\/fb-cdn.pipiads.com\/images\/pimg_71d287434cac842df6f45.png",
                        "name": "Geometric Print Drawstring Skinny Short Dress",
                        "source_product_link": "https:\/\/bloomchic.com\/products\/geometric-print-drawstring-skinny-waistline-inside-dress?variant=42774716743850&feed_id=fb4454601",
                        "price": 21.8,
                        "price_usd": 21.8,
                        "total_revenue": null
                    }
                ],
                "source_ad_id": null,
                "store": {
                    "id": "f65b3d7c58eb2b3fe1a54854ccfbadc9",
                    "ad_count": 51299,
                    "logo_url": "http:\/\/bloomchic.com\/cdn\/shop\/files\/20240102-144940_32x32.png?v=1704178240",
                    "name": "BloomChic",
                    "source_store_link": "https:\/\/bloomchic.com",
                    "e_commerce_platform": "shopify",
                    "e_commerce_types": null
                },
                "videos": null
            },
            {
                "id": "852992863852962",
                "active_days": 1,
                "ad_audience": null,
                "ad_audience_reach": null,
                "ad_link": "https:\/\/www.facebook.com\/ads\/library\/?id=852992863852962",
                "ad_content": "🏖️ From size 10 to 30, every body deserves to shine! Our inclusive range of plus-size swimwear offers unbeatable prices without compromising on style or fit. Don't settle for less, dive into affordable luxury today!",
                "ad_cost": null,
                "impression": null,
                "ad_cost_min": null,
                "ad_cost_max": null,
                "estimated_conversion_min": null,
                "estimated_conversion_max": null,
                "ad_forecast": 1,
                "ad_platform": [
                    "FACEBOOK",
                    "INSTAGRAM",
                    "AUDIENCE_NETWORK",
                    "MESSENGER",
                    "THREADS"
                ],
                "ad_started_at": 1761289200,
                "ad_ended_at": 1761289200,
                "ad_status": 1,
                "adset_count": 16,
                "advertiser": {
                    "id": "100842618611379",
                    "ad_count": 42579,
                    "ad_country": [],
                    "ads_library_link": "https:\/\/www.facebook.com\/ads\/library\/?active_status=active&ad_type=all&country=ALL&is_targeted_country=false&media_type=all&search_type=page&view_all_page_id=100842618611379",
                    "adset_count": null,
                    "like_count": 579749,
                    "name": "BloomChic",
                    "profile_picture_url": "https:\/\/cdn.pipidata.com\/images\/5b7079c262046251bde8e30f7e22f504.png",
                    "source_advertiser_id": "100842618611379",
                    "source_advertiser_link": null,
                    "e_commerce_platform": null
                },
                "button_type": "SHOP_NOW",
                "cards": null,
                "country": null,
                "first_discovered_at": 1761298420,
                "images": null,
                "landing_page_type": 2,
                "landing_pages": [
                    "https:\/\/bloomchic.com\/collections\/swim?sort_by=solid-keyhole-elastic-waist-gathered-one-piece-swimsuit"
                ],
                "language": null,
                "last_discovered_at": 1761298420,
                "latest_actived_at": 1761289200,
                "media_format": 1,
                "ad_caption": "bloomchic.com",
                "ad_title": "✨SIZES 10 TO 30✨",
                "ad_link_description": null,
                "button_text": "Shop now",
                "products": null,
                "source_ad_id": null,
                "store": {
                    "id": "f65b3d7c58eb2b3fe1a54854ccfbadc9",
                    "ad_count": 51299,
                    "logo_url": "http:\/\/bloomchic.com\/cdn\/shop\/files\/20240102-144940_32x32.png?v=1704178240",
                    "name": "BloomChic",
                    "source_store_link": "https:\/\/bloomchic.com",
                    "e_commerce_platform": "shopify",
                    "e_commerce_types": null
                },
                "videos": [
                    {
                        "cover_url": "https:\/\/cdn.pipidata.com\/images\/7c729064e26018c00bf8a0541640c81a.png",
                        "duration": 23,
                        "height": 1280,
                        "url": "https:\/\/cdn.pipidata.com\/videos\/b3f34ac3a0c7506fc178844c0c4b82c3.mp4",
                        "width": 720
                    }
                ]
            },
            {
                "id": "852791487259438",
                "active_days": 1,
                "ad_audience": null,
                "ad_audience_reach": null,
                "ad_link": "https:\/\/www.facebook.com\/ads\/library\/?id=852791487259438",
                "ad_content": "💃Discover your fashion style and show off your elegance!✨\nCreate the ultimate comfort for you and show your unique style.🌟 \nWhether it is daily wear or special occasions, it can perfectly match your personality and needs.\nCome on now and discover your ultimate fashion choice!\n#plus size clothing #fashionable and comfortable #confident and elegant",
                "ad_cost": null,
                "impression": null,
                "ad_cost_min": null,
                "ad_cost_max": null,
                "estimated_conversion_min": null,
                "estimated_conversion_max": null,
                "ad_forecast": 1,
                "ad_platform": [
                    "FACEBOOK",
                    "INSTAGRAM",
                    "AUDIENCE_NETWORK",
                    "MESSENGER",
                    "THREADS"
                ],
                "ad_started_at": 1761289200,
                "ad_ended_at": 1761289200,
                "ad_status": 1,
                "adset_count": 1,
                "advertiser": {
                    "id": "101668105367203",
                    "ad_count": 1044,
                    "ad_country": [],
                    "ads_library_link": "https:\/\/www.facebook.com\/ads\/library\/?active_status=active&ad_type=all&country=ALL&is_targeted_country=false&media_type=all&search_type=page&view_all_page_id=101668105367203",
                    "adset_count": null,
                    "like_count": 61516,
                    "name": "BloomChic Fashion",
                    "profile_picture_url": "https:\/\/cdn.pipidata.com\/images\/5b7079c262046251bde8e30f7e22f504.png",
                    "source_advertiser_id": "101668105367203",
                    "source_advertiser_link": null,
                    "e_commerce_platform": null
                },
                "button_type": "SHOP_NOW",
                "cards": [
                    {
                        "cover_url": null,
                        "duration": null,
                        "height": 1200,
                        "media_type": 2,
                        "url": "https:\/\/cdn.pipidata.com\/images\/b5ffe55ff28c64e33a8348e1600cf356.png",
                        "width": 1200
                    },
                    {
                        "cover_url": null,
                        "duration": null,
                        "height": 1200,
                        "media_type": 2,
                        "url": "https:\/\/cdn.pipidata.com\/images\/b5ffe55ff28c64e33a8348e1600cf356.png",
                        "width": 1200
                    },
                    {
                        "cover_url": null,
                        "duration": null,
                        "height": 1200,
                        "media_type": 2,
                        "url": "https:\/\/cdn.pipidata.com\/images\/c4bc8b7b4d7d42396761328a519eef39.png",
                        "width": 1200
                    },
                    {
                        "cover_url": null,
                        "duration": null,
                        "height": 1200,
                        "media_type": 2,
                        "url": "https:\/\/cdn.pipidata.com\/images\/b5ffe55ff28c64e33a8348e1600cf356.png",
                        "width": 1200
                    },
                    {
                        "cover_url": null,
                        "duration": null,
                        "height": 1200,
                        "media_type": 2,
                        "url": "https:\/\/cdn.pipidata.com\/images\/b5ffe55ff28c64e33a8348e1600cf356.png",
                        "width": 1200
                    },
                    {
                        "cover_url": null,
                        "duration": null,
                        "height": 1200,
                        "media_type": 2,
                        "url": "https:\/\/cdn.pipidata.com\/images\/b5ffe55ff28c64e33a8348e1600cf356.png",
                        "width": 1200
                    }
                ],
                "country": null,
                "first_discovered_at": 1761310641,
                "images": null,
                "landing_page_type": 3,
                "landing_pages": [
                    "https:\/\/bloomchic.com\/products\/geometric-print-drawstring-skinny-waistline-inside-dress?variant=42774716842154&feed_id=fb4454401",
                    "https:\/\/bloomchic.com\/products\/geometric-print-drawstring-skinny-waistline-inside-dress?variant=42774716711082&feed_id=fb4454701",
                    "https:\/\/bloomchic.com\/products\/plunging-neck-button-detail-pocket-maxi-dress?variant=42759663648938&feed_id=fb9739801",
                    "https:\/\/bloomchic.com\/",
                    "https:\/\/bloomchic.com\/products\/geometric-print-drawstring-skinny-waistline-inside-dress?variant=42774716743850&feed_id=fb4454601",
                    "https:\/\/bloomchic.com\/products\/geometric-print-drawstring-skinny-waistline-inside-dress?variant=42774716809386&feed_id=fb4454001",
                    "https:\/\/bloomchic.com\/products\/geometric-print-drawstring-skinny-waistline-inside-dress?variant=42774716678314&feed_id=fb4454201"
                ],
                "language": null,
                "last_discovered_at": 1761312868,
                "latest_actived_at": 1761289200,
                "media_format": 3,
                "ad_caption": "bloomchic.com",
                "ad_title": "{{product.current_price strip_zeros}}  | {{product.name}}",
                "ad_link_description": "",
                "button_text": "Shop now",
                "products": [
                    {
                        "id": "06f4503b3d07810ad2aec20b3eab46f2",
                        "ad_cost": null,
                        "ad_cost_ratio": null,
                        "ad_count": 653,
                        "ad_ended_at": 1761289200,
                        "ad_started_at": 1748502000,
                        "category_id": null,
                        "category_name": null,
                        "creation_time": 1648896600,
                        "currency": "USD",
                        "image_url": "https:\/\/fb-cdn.pipiads.com\/images\/pimg_71d287434cac842df6f45.png",
                        "name": "Geometric Print Drawstring Skinny Short Dress",
                        "source_product_link": "https:\/\/bloomchic.com\/products\/geometric-print-drawstring-skinny-waistline-inside-dress?variant=42774716743850&feed_id=fb4454601",
                        "price": 21.8,
                        "price_usd": 21.8,
                        "total_revenue": null
                    }
                ],
                "source_ad_id": null,
                "store": {
                    "id": "f65b3d7c58eb2b3fe1a54854ccfbadc9",
                    "ad_count": 51299,
                    "logo_url": "http:\/\/bloomchic.com\/cdn\/shop\/files\/20240102-144940_32x32.png?v=1704178240",
                    "name": "BloomChic",
                    "source_store_link": "https:\/\/bloomchic.com",
                    "e_commerce_platform": "shopify",
                    "e_commerce_types": null
                },
                "videos": null
            },
            {
                "id": "850127270910111",
                "active_days": 1,
                "ad_audience": null,
                "ad_audience_reach": null,
                "ad_link": "https:\/\/www.facebook.com\/ads\/library\/?id=850127270910111",
                "ad_content": "🏖️ Dive in and redefine your beach days with a fashion-forward splash! Time to shop, strut, and shine! 👙🌈🌞",
                "ad_cost": null,
                "impression": null,
                "ad_cost_min": null,
                "ad_cost_max": null,
                "estimated_conversion_min": null,
                "estimated_conversion_max": null,
                "ad_forecast": 1,
                "ad_platform": [
                    "FACEBOOK",
                    "INSTAGRAM",
                    "AUDIENCE_NETWORK",
                    "MESSENGER",
                    "THREADS"
                ],
                "ad_started_at": 1761289200,
                "ad_ended_at": 1761289200,
                "ad_status": 1,
                "adset_count": 1,
                "advertiser": {
                    "id": "100296078875911",
                    "ad_count": 7221,
                    "ad_country": [],
                    "ads_library_link": "https:\/\/www.facebook.com\/ads\/library\/?active_status=active&ad_type=all&country=ALL&is_targeted_country=false&media_type=all&search_type=page&view_all_page_id=100296078875911",
                    "adset_count": null,
                    "like_count": 239249,
                    "name": "BloomChic US",
                    "profile_picture_url": "https:\/\/cdn.pipidata.com\/images\/5b7079c262046251bde8e30f7e22f504.png",
                    "source_advertiser_id": "100296078875911",
                    "source_advertiser_link": null,
                    "e_commerce_platform": null
                },
                "button_type": "SHOP_NOW",
                "cards": null,
                "country": null,
                "first_discovered_at": 1761310633,
                "images": null,
                "landing_page_type": 2,
                "landing_pages": [
                    "https:\/\/bloomchic.com\/collections\/swim?sort_by=tropical-flower-print-pockets-one-piece-swimsuit"
                ],
                "language": null,
                "last_discovered_at": 1761310633,
                "latest_actived_at": 1761289200,
                "media_format": 1,
                "ad_caption": "bloomchic.com",
                "ad_title": "✨ SIZE 10 TO 30",
                "ad_link_description": null,
                "button_text": "Shop now",
                "products": null,
                "source_ad_id": null,
                "store": {
                    "id": "f65b3d7c58eb2b3fe1a54854ccfbadc9",
                    "ad_count": 51299,
                    "logo_url": "http:\/\/bloomchic.com\/cdn\/shop\/files\/20240102-144940_32x32.png?v=1704178240",
                    "name": "BloomChic",
                    "source_store_link": "https:\/\/bloomchic.com",
                    "e_commerce_platform": "shopify",
                    "e_commerce_types": null
                },
                "videos": [
                    {
                        "cover_url": "https:\/\/cdn.pipidata.com\/images\/73ae3fdcd9259c79a6a9877ef8971f13.png",
                        "duration": 25,
                        "height": 1278,
                        "url": "https:\/\/cdn.pipidata.com\/videos\/3e866f6b77394e24468f9573b815d05f.mp4",
                        "width": 720
                    }
                ]
            }
        ],
        "last_page": 6413,
        "per_page": 8,
        "total": 51299
    },
    "credits": {
        "remaining_credits": 745,
        "consumed_credits": 0,
        "total_credits": 745
    }
}
Example data from the existing documentation

Response structure

Name Type Required Constraints Display Name Description
» code integer true none Business status code
» message string true none Response Message none
» data object true none Response Data none
»» current_page integer true none Current Page none
»» data [object] true none Data List none
»»» id string true none Ad ID none
»»» country [string]¦null true none Country/Region none
»»» adset_count integer true none Ad Set Count none
»»» ad_audience_reach integer¦null true none Audience Reach none
»»» ad_cost number¦null true none Ad Spend Currency: USD
»»» ad_ended_at integer¦null true none Ad End Time Timestamp: seconds.
»»» ad_started_at integer¦null true none Ad Creation Time Timestamp: seconds.
»»» latest_actived_at integer¦null true none Ad Last Active Time Timestamp: seconds.
»»» first_discovered_at integer¦null true none Ad First Discovered Time Timestamp: seconds.
»»» last_discovered_at integer true none Ad Last Updated Time Timestamp: seconds.
»»» ad_content string¦null true none Ad Content none
»»» active_days integer¦null true none Active Days none
»»» landing_pages [string]¦null true none Landing Page URL none
»»» ad_status integer¦null true none Active Status Options: 1-Active, 2-Stopped, 3-Removed.
»»» ad_forecast integer¦null true none Ad Forecast Options: 1-Testing Phase, 2-Growth Phase, 3-Profit Phase.
»»» ad_platform [string]¦null true none Ad Platform none
»»» ad_audience object¦null true none Audience none
»»»» total_reach integer true none Total Audience Reach none
»»»» gender_audience string¦null true none Audience Gender none
»»»» age_audience object true none Audience Age Range none
»»»»» min integer¦null true none none
»»»»» max integer¦null true none none
»»»» details [object] true none Audience Country Details none
»»»»» country string true none Country none
»»»»» total_reach integer true none Audience Reach none
»»»»» age_gender_breakdowns [object] true none Audience Details none
»»»»»» age_range string¦null true none Age Range none
»»»»»» male integer¦null true none Male Count none
»»»»»» female integer¦null true none Female Count none
»»»»»» unknown integer¦null true none Unknown Count none
»»» language string¦null true none Language none
»»» media_format integer¦null true none Media Format Options: 1-Video, 2-Image, 3-Carousel.
»»» button_type string¦null true none Button Type none
»»» landing_page_type integer¦null true none Landing Page Type Options: 1-Product Landing Page, 2-Collection Landing Page, 3-Other.
»»» products [object]¦null true none Ad Products none
»»»» id string true none none
»»»» name string true none Product Name none
»»»» price number true none Product Price none
»»»» price_usd number true none Product Price (USD) none
»»»» ad_count integer true none Product Ad Count none
»»»» category_id string¦null true none Category ID none
»»»» category_name string¦null true none Category Name none
»»»» creation_time integer¦null true none Creation Time none
»»»» image_url string¦null true none Product Image none
»»»» ad_started_at integer true none Ad Start Time none
»»»» ad_ended_at integer true none Ad End Time none
»»»» ad_cost number¦null true none Ad Spend none
»»»» total_revenue number¦null true none Product Revenue none
»»»» ad_cost_ratio number¦null true none Product Ad Spend Ratio none
»»»» currency string¦null true none Currency none
»»» advertiser object¦null true none Advertiser none
»»»» id string true none none
»»»» source_advertiser_id string true none Page ID none
»»»» name string true none Advertiser Page Name none
»»»» ad_count integer true none Advertiser Page Ad Count none
»»»» like_count integer¦null true none Advertiser Page Likes none
»»»» profile_picture_url string¦null true none Advertiser Profile Picture URL none
»»»» source_advertiser_link string¦null true none Advertiser Source Link none
»»»» adset_count integer¦null true none Ad Set Count none
»»»» e_commerce_platform string¦null true none E-commerce Platform none
»»»» ad_country [string] true none Ad Countries none
»»»» ads_library_link string true none Library Link none
»»» images [object] true none Images none
»»»» url string true none Image URL none
»»»» width integer¦null true none Image Width none
»»»» height integer¦null true none Image Height none
»»» videos [object] true none Videos none
»»»» url string true none Video URL none
»»»» cover_url string¦null true none Video Cover URL none
»»»» width integer¦null true none Video Width none
»»»» height integer¦null true none Video Height none
»»»» duration integer¦null true none Video Duration none
»»» cards [object] true none Carousel none
»»»» media_type integer true none Media Type Options: 1-Video, 2-Image.
»»»» url string true none Video/Image URL none
»»»» cover_url string¦null true none Video Cover URL none
»»»» width integer¦null true none Video/Image Width none
»»»» height integer¦null true none Video/Image Height none
»»»» duration integer¦null true none Video Duration none
»»» store object¦null true none Ad Store none
»»»» id string true none Store ID none
»»»» name string true none Store Name none
»»»» ad_count integer true none Store Ad Count none
»»»» e_commerce_platform string¦null true none E-commerce Platform none
»»»» e_commerce_types [integer]¦null true none E-commerce Types none
»»»» logo_url string¦null true none Store Logo Image none
»»»» source_store_link string¦null true none Store Link none
»» last_page integer true none Last Page Number none
»» per_page integer true none Page Size none
»» total integer true none Total Count none
» credits object true none Credits information Credits information for the current API request
»» remaining_credits integer true none Remaining credits Remaining credits after this request
»» consumed_credits integer true none Consumed credits Credits consumed by this request
»» total_credits integer true none Total credits Total credits of the current credits type
Search the existing endpoint names and paths