API REFERENCE

Create Sales Monitor Task API

POST/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 POST 'https://api.ppspy.com/open-api/v1/sales-monitor-task' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: {API Key}' \
--data-raw '{
    "urls": [
        "https://www.google.com/",
        "wheelsup.cz"
    ],
    "with_fake_sales": true,
    "group_id": "6b602563ca8e3aeb59dd23904332113a"
}'

Request parameters 4 fields

Pass each parameter in its specified location.

Parameter	Type	Description
body body · optional	object	\| -
» urls body · required	[string]	\| Store URLs or domains to monitor. Supports batch submission, up to 50 per request
» with_fake_sales body · optional	boolean	Monitor stores with fake sales \| By default, stores with fake sales are not monitored. Set to true if you want to monitor them.
» group_id body · optional	integer¦null	Group ID \| none

Response example

Response · JSON

{
    "code": 200,
    "message": "success",
    "data": {
        "total": 2,
        "added_count": 1,
        "removed_count": 1,
        "details": [
            {
                "url": "https://www.google.com/",
                "domain": "www.google.com",
                "code": 400009,
                "message": "This site is not a shopify site, you can only submit shopify sites."
            },
            {
                "url": "wheelsup.cz",
                "domain": "wheelsup.cz",
                "code": 200,
                "message": "success"
            }
        ]
    },
    "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
»» total	integer	true	none		Total number of submitted store URLs
»» added_count	integer	true	none		Number of stores successfully added
»» removed_count	integer	true	none		Number of stores that failed to be added
»» details	[object]	true	none		Detailed results for each store addition
»»» url	string(uri)	true	none		Submitted store URL
»»» domain	string	true	none		Store domain
»»» code	integer	true	none		Result status code: 200 indicates success, other values indicate failure
»»» message	string	true	none		Detailed description of the result
» 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: Create Sales Monitor Task
Request Method: POST
API URL: /open-api/v1/sales-monitor-task
Pricing: Each successfully created monitor task consumes 1 monitoring quota