PPSPYAPI Platform
EN / 中文
Docs/Ad Monitor/Reference
API REFERENCE

Monitor Task Ad Product Overview API

POST/open-api/v1/ad-monitor-task/ad-products-overview
·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-products-overview' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: {API Key}' \
--data-raw '{
    "task_id": "902175d02614903e4944dfdfe85bbb4d",
    "page": 1,
    "per_page": 10
}'

Request parameters 4 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
» page
body · optional
integer Page Number | Minimum value is 1.
» per_page
body · optional
integer Page Size | Value range: 1-100.

Response example

Response · JSON
{
    "code": 200,
    "message": "success",
    "data": {
        "current_page": 1,
        "data": [
            {
                "product_id": "06f4503b3d07810ad2aec20b3eab46f2",
                "product_url": "https:\/\/bloomchic.com\/products\/geometric-print-drawstring-skinny-waistline-inside-dress?variant=42774716711082&feed_id=fb4454701",
                "product_name": "Geometric Print Drawstring Skinny Short Dress",
                "product_image_url": "https:\/\/fb-cdn.pipiads.com\/images\/pimg_71d287434cac842df6f45.png",
                "ad_count": 634,
                "proportion": 1.24
            },
            {
                "product_id": "ce047b08c273540fd6d364c6ea2779e2",
                "product_url": "https:\/\/bloomchic.com\/products\/plunging-neck-button-detail-pocket-maxi-dress?variant=42759663648938&feed_id=fb9739801",
                "product_name": "Plunging Neck Button Detail Pocket Maxi Dress",
                "product_image_url": "https:\/\/fb-cdn.pipiads.com\/images\/pimg_7b3411f14f53ac20eed6a.png",
                "ad_count": 548,
                "proportion": 1.07
            },
            {
                "product_id": "19cd1b54816e321183e115dd770304e3",
                "product_url": "https:\/\/bloomchic.com\/products\/ditsy-floral-elastic-waist-ruffles-pocket-knee-dress?variant=43090401099946&feed_id=fb9738901",
                "product_name": "Bloom Dress - Ditsy Floral Elastic Waist Ruffles Pocket Knee Dress",
                "product_image_url": "https:\/\/fb-cdn.pipiads.com\/images\/pimg_af7ed5240540be0cd6da.png",
                "ad_count": 266,
                "proportion": 0.52
            },
            {
                "product_id": "88c569b53c835bfb69ab5b3ef2d273d7",
                "product_url": "https:\/\/bloomchic.com\/products\/solid-pocket-contrast-lace-split-modal-maxi-dress?variant=43060164821162&feed_id=fb2136101",
                "product_name": "Solid Pocket Contrast Lace Split Maxi Dress",
                "product_image_url": "https:\/\/fb-cdn.pipiads.com\/images\/pimg_748e674c0fbade204499a.png",
                "ad_count": 218,
                "proportion": 0.43
            },
            {
                "product_id": "1c19b5adfafcd866c686af014004bafd",
                "product_url": "https:\/\/bloomchic.com\/products\/solid-side-pocket-modal-midi-peasant-dress?variant=42572898009258&feed_id=fb3967901",
                "product_name": "Solid Side Pocket Modal Midi Peasant Dress",
                "product_image_url": "https:\/\/fb-cdn.pipiads.com\/images\/pimg_30a6463e0bc1140b5b2c7.png",
                "ad_count": 184,
                "proportion": 0.36
            },
            {
                "product_id": "3290d7fed2c2deb2854bea573825ffe5",
                "product_url": "https:\/\/bloomchic.com\/products\/skinny-very-stretchy-high-rise-black-wash-sculpt-waist-jeans?variant=43345622204586&feed_id=fb2106901",
                "product_name": "Skinny Very Stretchy High Rise Black Wash Sculpt Waist Jeans",
                "product_image_url": "https:\/\/fb-cdn.pipiads.com\/images\/pimg_d71e51c424586e6689501.png",
                "ad_count": 163,
                "proportion": 0.32
            },
            {
                "product_id": "1302168b5819a268917e5c8c713c9ab1",
                "product_url": "https:\/\/bloomchic.com\/products\/skinny-very-stretchy-mid-rise-dark-wash-gap-proof-jeans?variant=43191001743530&feed_id=fb5151701",
                "product_name": "Skinny Very Stretchy High Rise Dark Wash Gap Proof Jeans",
                "product_image_url": "https:\/\/fb-cdn.pipiads.com\/images\/pimg_48987d78414edfb571d2.png",
                "ad_count": 161,
                "proportion": 0.31
            },
            {
                "product_id": "2a88b878dc37de986465a89f1ea393ad",
                "product_url": "https:\/\/bloomchic.com\/products\/scoop-neck-pocket-floral-short-dress?variant=42611501662378&feed_id=fb3687901",
                "product_name": "Bloom Dress - Scoop Neck Pocket Floral Short Dress",
                "product_image_url": "https:\/\/fb-cdn.pipiads.com\/images\/pimg_e00d7bd11b4ee08d53599.png",
                "ad_count": 134,
                "proportion": 0.26
            },
            {
                "product_id": "f02ff58481555263b8792c33584c9be7",
                "product_url": "https:\/\/bloomchic.com\/products\/ditsy-floral-v-neck-ruffle-tie-front-blouse?variant=42895560638634&feed_id=fb2653601",
                "product_name": "Ditsy Floral V Neck Ruffle Tie Front Blouse",
                "product_image_url": "https:\/\/fb-cdn.pipiads.com\/images\/pimg_73d485f2db3a51d17e6bf.png",
                "ad_count": 128,
                "proportion": 0.25
            },
            {
                "product_id": "2abc3fd717a642511ab7175deee73f7d",
                "product_url": "https:\/\/bloomchic.au\/products\/supersoft-essentials-colorblock-contrast-pocket-cardigan-1?variant=45924066754809&feed_id=fb48271801",
                "product_name": "Supersoft Essentials Colorblock Contrast Pocket Cardigan",
                "product_image_url": "https:\/\/fb-cdn.pipiads.com\/images\/pimg_a6678c847a48038974e20.png",
                "ad_count": 95,
                "proportion": 0.19
            }
        ],
        "last_page": 16,
        "per_page": 10,
        "total": 151
    },
    "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 Number none
»» data [object] true none Data List none
»»» product_id string true none Product ID none
»»» product_url string true none Product URL none
»»» product_name string true none Product Name none
»»» product_image_url string true none Product Image URL none
»»» ad_count integer true none Ad Count none
»»» proportion number true none Proportion (Percentage) 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
Original API information and base URL

Base URLs

  • Production Environment: https://api.ppspy.com

API Information

  • API Name: Monitor Task Ad Product Overview
  • Request Method: POST
  • API URL: /open-api/v1/ad-monitor-task/ad-products-overview
  • Usage Note: Free
GETCurrent Credits/open-api/v1/creditsGETShopify Store List/open-api/v1/shopGETShopify Store Details/open-api/v1/shop/{id}GETStore Traffic List/open-api/v1/shop/traffic-shopGETSingle Product Store List/open-api/v1/shop/single-product-shopGETShopify Theme Store List/open-api/v1/shop/theme-shopGETShopify Product List/open-api/v1/productGETShopify Bestselling Products List/open-api/v1/bestsellersPOSTAdvertisement List/open-api/v1/advertisements/searchGETAdvertisement Details/open-api/v1/advertisements/{id}POSTAd Store List/open-api/v1/ad-stores/searchGETAd Store Details/open-api/v1/ad-stores/{id}GETAd Store Landing Page Stats/open-api/v1/ad-stores/landing-pages-ad-countGETAd Store Advertising Trends/open-api/v1/ad-stores/analysisGETAd Store Placement Analysis/open-api/v1/ad-stores/deep-analysisGETStore Ad Content Most Used/open-api/v1/ad-stores/ad-contentGETStore Ad Content Longest Run/open-api/v1/ad-stores/ad-content-longest-runGETAdvertisers for Ad Store/open-api/v1/ad-stores/advertisersPOSTAd Product List/open-api/v1/ad-products/searchGETAd Product Details/open-api/v1/ad-products/{id}POSTCreate Group/open-api/v1/ad-monitor-groupsGETGroup List/open-api/v1/ad-monitor-groupsPUTEdit Group/open-api/v1/ad-monitor-groups/{id}DELETEDelete Group/open-api/v1/ad-monitor-groups/{id}POSTSearch Advertisers/open-api/v1/ad-monitor-task/search-fb-ads-advertiser
Search the existing endpoint names and paths