API REFERENCE
Monitor Task Ad Copy Most Used API
POST
/open-api/v1/ad-monitor-task/ad-copy-most-used·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
AUTHORIZATION
Authorization: {API Key}CONTENT-TYPE
application/jsonACCEPT
application/jsonRequest example
cURL
curl --location --request POST 'https://api.ppspy.com/open-api/v1/ad-monitor-task/ad-copy-most-used' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: {API Key}' \
--data-raw '{
"task_id": "902175d02614903e4944dfdfe85bbb4d",
"order_by": "ad_count",
"direction": "desc",
"page": 1,
"per_page": 10
}' Request parameters
Pass each parameter in its specified location.
| Parameter | Type | Description |
|---|---|---|
| body
body · optional
| object | | none |
| » task_id
body · required
| string | Monitor Task ID | none |
| » order_by
body · optional
| string | Sort Field | Available values: ad_count - Ad count, last_discovered_at - Last used date. |
| » direction
body · optional
| string | Sort Direction | Available values: desc - Descending, asc - Ascending. |
| » 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": [
{
"ad_content": "🙌 Embrace a world of choice, comfort, and stunning style for sizes 10-30. Shop now and express yourself like never before.💃",
"ad_count": 4415,
"proportion": 8.62,
"last_discovered_at": 1761289200
},
{
"ad_content": "Are you ready for your next chapter? Our new styles are about to become your favorites 🧡",
"ad_count": 4021,
"proportion": 7.85,
"last_discovered_at": 1761202800
},
{
"ad_content": "✨ Elevate your style to new heights, tailored uniquely to your taste.",
"ad_count": 3583,
"proportion": 7,
"last_discovered_at": 1761289200
},
{
"ad_content": "Get ready to be amazed! Our latest arrivals at BloomChic are flying off the shelves. Don't wait too long – grab them before they're gone!",
"ad_count": 3579,
"proportion": 6.99,
"last_discovered_at": 1761202800
},
{
"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_count": 3576,
"proportion": 6.99,
"last_discovered_at": 1761289200
},
{
"ad_content": "Are you ready for your next chapter? Our new styles are about to become your favorites 💖",
"ad_count": 1713,
"proportion": 3.35,
"last_discovered_at": 1761202800
},
{
"ad_content": "🎃It's officially Halloween at BloomChic! Shop our spooky-cute outfits for all your wicked plans. Don't miss out on the magic! 🕸️🖤",
"ad_count": 1475,
"proportion": 2.88,
"last_discovered_at": 1761116400
},
{
"ad_content": "Your curves deserve only the BEST. \nShop promotional items in sizes 10-30 and find styles in every trend. 🙌",
"ad_count": 1261,
"proportion": 2.46,
"last_discovered_at": 1761202800
},
{
"ad_content": "🏖️ Dive in and redefine your beach days with a fashion-forward splash! Time to shop, strut, and shine! 👙🌈🌞",
"ad_count": 1002,
"proportion": 1.96,
"last_discovered_at": 1761289200
},
{
"ad_content": "✨ Find the perfect outfit for any occasion at BloomChic. Check out these styles for sizes 10-30🏖️",
"ad_count": 606,
"proportion": 1.18,
"last_discovered_at": 1761202800
}
],
"last_page": 280,
"per_page": 10,
"total": 2792
},
"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 |
| »»» ad_content | string | true | none | Ad Copy Content | none |
| »»» ad_count | integer | true | none | Number of Ads Using This Copy | none |
| »»» proportion | number | true | none | Proportion (Percentage) | none |
| »»» last_discovered_at | integer¦null | true | none | Last Used Date | Timestamp in seconds. |
| »» 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 |
