API REFERENCE

Sales Monitor Task Overview API

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

Request parameters 1 fields

Pass each parameter in its specified location.

Parameter	Type	Description
group_id query · optional	string	Group ID \| none

Response example

Response · JSON

{
    "code": 200,
    "message": "success",
    "data": {
        "sales": 29,
        "income_usd": 14554.02,
        "sales_today": 29,
        "income_usd_today": 14554.02,
        "sales_yesterday": 0,
        "income_usd_yesterday": 0,
        "sales_7days": 29,
        "income_usd_7days": 14554.02
    },
    "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
»» sales	integer	true	none	Total Sales	none
»» income_usd	number	true	none	Total Estimated Revenue (USD)	none
»» sales_today	integer	true	none	Today's Sales	none
»» income_usd_today	number	true	none	Today's Estimated Revenue (USD)	none
»» sales_yesterday	integer	true	none	Yesterday's Sales	none
»» income_usd_yesterday	integer	true	none	Yesterday's Estimated Revenue (USD)	none
»» sales_7days	integer	true	none	7-Day Sales	none
»» income_usd_7days	integer	true	none	7-Day Estimated Revenue (USD)	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 Overview
Request Method: GET
API URL: /open-api/v1/sales-monitor-task/overview
Usage Note: Free