API REFERENCE
Monitor Task Ad Copy Longest Running API
POST
/open-api/v1/ad-monitor-task/ad-copy-longest-run·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-longest-run' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: {API Key}' \
--data-raw '{
"task_id": "902175d02614903e4944dfdfe85bbb4d",
"order_by": "active_days",
"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 |
| » advertiser_id
body · optional
| string | Advertiser ID | none |
| » related_store_id
body · optional
| string | Store ID | none |
| » order_by
body · optional
| string | Sort Field | Options: active_days - Active Days, ad_started_at - Ad Start Date. |
| » direction
body · optional
| string | Sort Direction | Options: desc - Descending, asc - Ascending. |
| » page
body · optional
| integer | Page Number | Minimum value is 1. |
| » per_page
body · optional
| integer | Page Size | Range: 1-100. |
Response example
Response · JSON
{
"code": 200,
"message": "success",
"data": {
"current_page": 1,
"data": [
{
"ad_id": "690790813314649",
"media_format": 1,
"images": null,
"videos": [
{
"cover_url": "https:\/\/cdn.pipidata.com\/images\/ca4036d3719ad12ff6b2520f6d584c0b.png",
"url": "https:\/\/cdn.pipidata.com\/videos\/db4c201c62aa3f6ce493fe65b13a9a18.mp4"
}
],
"cards": null,
"ad_content": "🙌 Embrace a world of choice, comfort, and stunning style for sizes 10-30. Shop now and express yourself like never before.💃",
"active_days": 203,
"ad_status": 1,
"ad_started_at": 1743577200
},
{
"ad_id": "1359998978580431",
"media_format": 1,
"images": null,
"videos": [
{
"cover_url": "https:\/\/cdn.pipidata.com\/images\/fcab53598cfeb9b21d23fa955499ca46.png",
"url": "https:\/\/cdn.pipidata.com\/videos\/cb879bc2d6c0194b7d13cd44b413fe01.mp4"
}
],
"cards": null,
"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!",
"active_days": 193,
"ad_status": 3,
"ad_started_at": 1744268400
},
{
"ad_id": "1170464520973657",
"media_format": 1,
"images": null,
"videos": [
{
"cover_url": "https:\/\/cdn.pipidata.com\/images\/3b6cb641180776ccaf8e8fdb0fdc002d.png",
"url": "https:\/\/cdn.pipidata.com\/videos\/b4a0ade7eec7979ffd7a1deb65cc5b2a.mp4"
}
],
"cards": null,
"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!",
"active_days": 193,
"ad_status": 3,
"ad_started_at": 1744268400
},
{
"ad_id": "1139941097886071",
"media_format": 1,
"images": null,
"videos": [
{
"cover_url": "https:\/\/cdn.pipidata.com\/images\/7245c7a14294400880f85d26b19c8618.png",
"url": "https:\/\/cdn.pipidata.com\/videos\/55c4b667bd876f12f51759fd775dd26a.mp4"
}
],
"cards": null,
"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!",
"active_days": 193,
"ad_status": 3,
"ad_started_at": 1744268400
},
{
"ad_id": "984602047119089",
"media_format": 1,
"images": null,
"videos": [
{
"cover_url": "https:\/\/cdn.pipidata.com\/images\/f647a4ffb7572835dbf839b04c5239b3.png",
"url": "https:\/\/cdn.pipidata.com\/videos\/92a4277a84a1a47a8e55390aee0c4c41.mp4"
}
],
"cards": null,
"ad_content": "🙌 Embrace a world of choice, comfort, and stunning style for sizes 10-30. Shop now and express yourself like never before.💃",
"active_days": 192,
"ad_status": 3,
"ad_started_at": 1744268400
},
{
"ad_id": "3809882962598700",
"media_format": 1,
"images": null,
"videos": [
{
"cover_url": "https:\/\/cdn.pipidata.com\/images\/5b86e11a70f7e1245379fc87c9081b03.png",
"url": "https:\/\/cdn.pipidata.com\/videos\/54e3f1059af27a48e43c578a7fb9ce1b.mp4"
}
],
"cards": null,
"ad_content": "Dive into style with BloomChic's swimwear! 🌊 Designed for sizes 10-30, our collection offers unparalled comfort and elegance. Feel confident and beautiful this summer 👙",
"active_days": 192,
"ad_status": 3,
"ad_started_at": 1744268400
},
{
"ad_id": "2400280980339121",
"media_format": 1,
"images": null,
"videos": [
{
"cover_url": "https:\/\/cdn.pipidata.com\/images\/0e357a9243a7529c2e17f5bf80568538.png",
"url": "https:\/\/cdn.pipidata.com\/videos\/dcebaa93c6a0e8aece146ccff7bde885.mp4"
}
],
"cards": null,
"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!",
"active_days": 192,
"ad_status": 3,
"ad_started_at": 1744268400
},
{
"ad_id": "1430163374615759",
"media_format": 1,
"images": null,
"videos": [
{
"cover_url": "https:\/\/cdn.pipidata.com\/images\/a4a5f9aeb01d5d533343aa20180607a6.png",
"url": "https:\/\/cdn.pipidata.com\/videos\/98cc09a03eb6eaa4d99e946c9bfb60d5.mp4"
}
],
"cards": null,
"ad_content": "🏖️ Dive in and redefine your beach days with a fashion-forward splash! Time to shop, strut, and shine! 👙🌈🌞",
"active_days": 192,
"ad_status": 3,
"ad_started_at": 1744268400
},
{
"ad_id": "1321573755618157",
"media_format": 1,
"images": null,
"videos": [
{
"cover_url": "https:\/\/cdn.pipidata.com\/images\/5473f256f86af7dba4460968dfbfc17e.png",
"url": "https:\/\/cdn.pipidata.com\/videos\/fd32d5fda75d447700c3e7d359286e3e.mp4"
}
],
"cards": null,
"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!",
"active_days": 192,
"ad_status": 3,
"ad_started_at": 1744268400
},
{
"ad_id": "1310855453309641",
"media_format": 1,
"images": null,
"videos": [
{
"cover_url": "https:\/\/cdn.pipidata.com\/images\/08b203190118e730f62d8ea7e7094767.png",
"url": "https:\/\/cdn.pipidata.com\/videos\/f7745adceedac57f89397d53301cddda.mp4"
}
],
"cards": null,
"ad_content": "🙌 Embrace a world of choice, comfort, and stunning style for sizes 10-30. Shop now and express yourself like never before.💃",
"active_days": 192,
"ad_status": 3,
"ad_started_at": 1744268400
}
],
"last_page": 5123,
"per_page": 10,
"total": 51225
},
"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 |
| »»» ad_id | string | true | none | Ad ID | none |
| »»» media_format | integer | true | none | Media Format | Options: 1 - Video, 2 - Image, 3 - Carousel. |
| »»» images | [object]¦null | true | none | Images | none |
| »»»» height | integer | false | none | Image Height | none |
| »»»» url | string | false | none | Image URL | none |
| »»»» width | integer | false | none | Image Width | none |
| »»» videos | [object]¦null | true | none | Videos | none |
| »»»» cover_url | string¦null | false | none | Video Cover Image URL | none |
| »»»» duration | integer¦null | false | none | Video Duration | none |
| »»»» height | integer | false | none | Video Height | none |
| »»»» url | string | false | none | Video URL | none |
| »»»» width | integer | false | none | Video Width | none |
| »»» cards | [object]¦null | true | none | Carousel | none |
| »»»» cover_url | string¦null | false | none | Video Cover Image URL | none |
| »»»» duration | integer¦null | false | none | Video Duration | none |
| »»»» height | integer | false | none | Video/Image Height | none |
| »»»» media_type | integer | false | none | Media Type | Options: 1 - Video, 2 - Image. |
| »»»» url | string | false | none | Video/Image URL | none |
| »»»» width | integer | false | none | Video/Image Width | none |
| »»» ad_content | string | true | none | Ad Copy Content | none |
| »»» active_days | integer | true | none | Active Days | none |
| »»» ad_status | integer | true | none | Ad Status | Options: 1 - Active, 2 - Stopped, 3 - Removed. |
| »»» ad_started_at | integer | true | none | Ad Start 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 |
