API REFERENCE

Sales Monitor Task List API

GET/open-api/v1/sales-monitor-task

·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 GET 'https://api.ppspy.com/open-api/v1/sales-monitor-task' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: {API Key}'

Request parameters 8 fields

Pass each parameter in its specified location.

Parameter	Type	Description
keyword query · optional	string	Search Keyword \| Search keyword for filtering
monitor_task_status query · optional	integer	Monitor Status \| Monitor status, optional values: 0-Stopped, 1-Monitoring.
note query · optional	string	Note \| Note or memo
order_by query · optional	string	Sort Field \| Sort field, optional values: monitor_task_created_at-Monitor task creation time, monitor_task_sales_today-Today's sales, monitor_task_sales_yesterday-Yesterday's sales, monitor_task_sales_7days-7-day sales, monitor_task_sales-Total sales, monitor_task_product_quantity-Store product count.
direction query · optional	string	Sort Direction \| Sort direction, optional values: desc-Descending, asc-Ascending.
page query · optional	integer	Page Number \| Page number, minimum value is 1.
per_page query · optional	integer	Page Size \| Page size, range 1-100.
group_id query · optional	string	Group ID \| Group ID

Response example

Response · JSON

{
    "code": 200,
    "message": "success",
    "data": {
        "current_page": 1,
        "data": [
            {
                "site_domain": "wheelsup.cz",
                "site_name": "WheelsUp",
                "site_icon": "https://wheelsup.cz/cdn/shop/files/apple-touch-icon.png?crop=center&height=96&v=1675197115&width=96",
                "currency": "CZK",
                "monitor_task_status": 1,
                "note": null,
                "monitor_task_income_today": 15319670.73,
                "monitor_task_income_usd_today": 698163.9,
                "monitor_task_sales_today": 1393,
                "monitor_task_income_yesterday": 32750882.58,
                "monitor_task_income_usd_yesterday": 1492557.13,
                "monitor_task_sales_yesterday": 2978,
                "monitor_task_income": 447661168.28,
                "monitor_task_income_usd": 20163747.33,
                "monitor_task_sales": 42291,
                "monitor_task_created_at": 1747100358,
                "monitor_task_product_quantity": 28041,
                "group_id": "6b602563ca8e3aeb59dd23904332113a",
                "monitor_task_income_7days": 191622814.92,
                "monitor_task_income_usd_7days": 8684724.09,
                "monitor_task_sales_7days": 17543,
                "group": {
                    "id": "6b602563ca8e3aeb59dd23904332113a",
                    "name": "测试分组-1762422493"
                }
            }
        ],
        "last_page": 1,
        "per_page": 10,
        "total": 1
    },
    "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
»»» site_domain	string	true	none	Store Domain	none
»»» site_name	string	true	none	Store Name	none
»»» site_icon	string	true	none	Store Icon	none
»»» currency	string	true	none	Currency	none
»»» monitor_task_status	integer	true	none	Monitor Task Status	Optional values: 0-Stopped, 1-Monitoring.
»»» note	string¦null	true	none	Note	none
»»» monitor_task_income_today	number¦null	true	none	Today's Estimated Revenue	none
»»» monitor_task_sales_today	integer¦null	true	none	Today's Sales	none
»»» monitor_task_income_yesterday	number¦null	true	none	Yesterday's Estimated Revenue	none
»»» monitor_task_sales_yesterday	integer¦null	true	none	Yesterday's Sales	none
»»» monitor_task_income	number¦null	true	none	Total Estimated Revenue	none
»»» monitor_task_sales	integer¦null	true	none	Total Sales	none
»»» monitor_task_created_at	integer	true	none	Monitor Task Created At	none
»»» monitor_task_product_quantity	integer¦null	true	none	Store Product Count	none
»»» monitor_task_income_usd	number¦null	true	none	Total Estimated Revenue (USD)	none
»»» monitor_task_income_usd_today	number¦null	true	none	Today's Estimated Revenue (USD)	none
»»» monitor_task_income_usd_yesterday	number¦null	true	none	Yesterday's Estimated Revenue (USD)	none
»»» group_id	string¦null	true	none	Group ID	none
»»» group	object¦null	true	none	Group Information	none
»»»» id	string	true	none	Group ID	none
»»»» name	string	true	none	Group Name	none
»»» monitor_task_income_7days	number¦null	true	none	7-Day Estimated Revenue	none
»»» monitor_task_income_usd_7days	number¦null	true	none	7-Day Estimated Revenue (USD)	none
»»» monitor_task_sales_7days	integer¦null	true	none	7-Day Sales	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: Sales Monitor Task List
Request Method: GET
API URL: /open-api/v1/sales-monitor-task
Usage Note: Free