API REFERENCE

Sales Monitor Task Details API

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

·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/detail?site_domain=wheelsup.cz&period_id=9e22dafdfa8899970767642edfcfb123b35ba89338637be7f0a650e861f2bea4' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: {API Key}'

Request parameters 2 fields

Pass each parameter in its specified location.

Parameter	Type	Description
site_domain query · required	string	Store Domain \|
period_id query · optional	string	Monitor Period ID \| If not provided, returns data for the latest monitoring period by default.

Response example

Response · JSON

{
    "code": 200,
    "message": "success",
    "data": {
        "monitor_site": {
            "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,
            "monthly_visits": 0,
            "tracked_users": 0,
            "first_product_created_at": 1670722999,
            "is_fake_sales": false
        },
        "periods": [
            {
                "id": "9e22dafdfa8899970767642edfcfb123b35ba89338637be7f0a650e861f2bea4",
                "started_at": 1762504305,
                "ended_at": 1762766114,
                "task_status": 1,
                "reported_at": 1762758710
            }
        ],
        "period_details": {
            "income": 205636976.8,
            "sales": 19472,
            "income_today": 19822340.05,
            "sales_today": 1877,
            "income_yesterday": 69985427.55,
            "sales_yesterday": 6627,
            "product_quantity": 25001,
            "product_avg_price": 10560.65,
            "income_usd": 0,
            "income_usd_today": 0,
            "income_usd_yesterday": 0,
            "income_7days": 205636976.8,
            "income_usd_7days": 0,
            "sales_7days": 19472,
            "product_avg_price_usd": null,
            "real_time_sales_task_id": "e72e0578cc760e7f06989082bde42547"
        },
        "sales_daily": [
            {
                "sold_date": "2025-11-07",
                "income": 43446514.1,
                "income_usd": null,
                "sales": 4114,
                "sales_hour": []
            },
            {
                "sold_date": "2025-11-08",
                "income": 72382695.1,
                "income_usd": null,
                "sales": 6854,
                "sales_hour": []
            },
            {
                "sold_date": "2025-11-09",
                "income": 69985427.55,
                "income_usd": null,
                "sales": 6627,
                "sales_hour": []
            },
            {
                "sold_date": "2025-11-10",
                "income": 19822340.05,
                "income_usd": null,
                "sales": 1877,
                "sales_hour": [
                    {
                        "sold_date": "2025-11-10",
                        "sold_hour": "2025-11-10 00:00:00",
                        "income": 3168195,
                        "income_usd": null,
                        "sales": 300
                    },
                    {
                        "sold_date": "2025-11-10",
                        "sold_hour": "2025-11-10 01:00:00",
                        "income": 2428949.5,
                        "income_usd": null,
                        "sales": 230
                    },
                    {
                        "sold_date": "2025-11-10",
                        "sold_hour": "2025-11-10 02:00:00",
                        "income": 2978103.3,
                        "income_usd": null,
                        "sales": 282
                    },
                    {
                        "sold_date": "2025-11-10",
                        "sold_hour": "2025-11-10 03:00:00",
                        "income": 2978103.3,
                        "income_usd": null,
                        "sales": 282
                    },
                    {
                        "sold_date": "2025-11-10",
                        "sold_hour": "2025-11-10 04:00:00",
                        "income": 2407828.2,
                        "income_usd": null,
                        "sales": 228
                    },
                    {
                        "sold_date": "2025-11-10",
                        "sold_hour": "2025-11-10 05:00:00",
                        "income": 2714087.05,
                        "income_usd": null,
                        "sales": 257
                    },
                    {
                        "sold_date": "2025-11-10",
                        "sold_hour": "2025-11-10 06:00:00",
                        "income": 2756329.65,
                        "income_usd": null,
                        "sales": 261
                    },
                    {
                        "sold_date": "2025-11-10",
                        "sold_hour": "2025-11-10 07:00:00",
                        "income": 390744.05,
                        "income_usd": null,
                        "sales": 37
                    }
                ]
            }
        ],
        "sales_today": {
            "sales_hour": [
                {
                    "sold_date": "2025-11-10",
                    "sold_hour": "2025-11-10 00:00:00",
                    "income": 3168195,
                    "income_usd": null,
                    "sales": 300
                },
                {
                    "sold_date": "2025-11-10",
                    "sold_hour": "2025-11-10 01:00:00",
                    "income": 2428949.5,
                    "income_usd": null,
                    "sales": 230
                },
                {
                    "sold_date": "2025-11-10",
                    "sold_hour": "2025-11-10 02:00:00",
                    "income": 2978103.3,
                    "income_usd": null,
                    "sales": 282
                },
                {
                    "sold_date": "2025-11-10",
                    "sold_hour": "2025-11-10 03:00:00",
                    "income": 2978103.3,
                    "income_usd": null,
                    "sales": 282
                },
                {
                    "sold_date": "2025-11-10",
                    "sold_hour": "2025-11-10 04:00:00",
                    "income": 2407828.2,
                    "income_usd": null,
                    "sales": 228
                },
                {
                    "sold_date": "2025-11-10",
                    "sold_hour": "2025-11-10 05:00:00",
                    "income": 2714087.05,
                    "income_usd": null,
                    "sales": 257
                },
                {
                    "sold_date": "2025-11-10",
                    "sold_hour": "2025-11-10 06:00:00",
                    "income": 2756329.65,
                    "income_usd": null,
                    "sales": 261
                },
                {
                    "sold_date": "2025-11-10",
                    "sold_hour": "2025-11-10 07:00:00",
                    "income": 390744.05,
                    "income_usd": null,
                    "sales": 37
                }
            ]
        }
    },
    "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
»» monitor_site	object	false	none	Store Basic Information	none
»»» site_domain	string	true	none	Store Domain	none
»»» site_name	string	true	none	Store Name	none
»»» site_icon	string¦null	true	none	Store Icon	none
»»» currency	string	true	none	Currency	none
»»» monitor_task_status	integer	true	none	Monitor Task Status	Options: 0-Stopped, 1-Monitoring.
»»» note	string¦null	true	none	Note	none
»»» monthly_visits	integer¦null	true	none	Monthly Visits	none
»»» tracked_users	integer	true	none	Number of Users Monitoring Simultaneously	none
»»» first_product_created_at	integer¦null	true	none	First Product Creation Time	Timestamp in seconds.
»»» is_fake_sales	boolean¦null	true	none	Whether Monitoring Store with Fake Sales	none
»» periods	[object]	false	none	Monitor Period List	none
»»» id	string	true	none	Monitor Period ID	none
»»» started_at	integer	true	none	Monitor Start Time	Timestamp in seconds.
»»» ended_at	integer	true	none	Monitor End Time	Timestamp in seconds.
»»» task_status	integer	true	none	Monitor Task Status	Options: 0-Stopped, 1-Monitoring.
»»» reported_at	integer¦null	true	none	Last Statistics Time	Timestamp in seconds.
»» period_details	object	false	none	Monitoring Data for Current Period	none
»»» income	number¦null	true	none	Estimated Total Sales Revenue	none
»»» sales	integer¦null	true	none	Total Sales Volume	none
»»» income_today	number¦null	true	none	Today's Estimated Sales Revenue	none
»»» sales_today	integer¦null	true	none	Today's Sales Volume	none
»»» income_yesterday	number¦null	true	none	Yesterday's Estimated Sales Revenue	none
»»» sales_yesterday	integer¦null	true	none	Yesterday's Sales Volume	none
»»» income_7days	number¦null	true	none	7-Day Estimated Sales Revenue	none
»»» income_usd_7days	number¦null	true	none	7-Day Estimated Sales Revenue (USD)	none
»»» sales_7days	integer	true	none	7-Day Sales Volume	none
»»» product_quantity	integer¦null	true	none	Store Product Count	none
»»» product_avg_price	number¦null	true	none	Store Average Price	none
»»» product_avg_price_usd	number¦null	true	none	Store Average Price (USD)	none
»»» income_usd	number¦null	true	none	Estimated Total Sales Revenue (USD)	none
»»» income_usd_today	number¦null	true	none	Today's Estimated Sales Revenue (USD)	none
»»» income_usd_yesterday	number¦null	true	none	Yesterday's Estimated Sales Revenue (USD)	none
»»» real_time_sales_task_id	string¦null	true	none	Real-time Sales Task ID	Returned only when monitoring is active, otherwise null
»» sales_daily	[object]	false	none	Daily Sales Statistics	none
»»» sold_date	string	true	none	Sales Date	UTC time
»»» income	number	true	none	Daily Estimated Sales Revenue	none
»»» sales	integer	true	none	Daily Sales Volume	none
»»» income_usd	number¦null	true	none	Daily Estimated Sales Revenue (USD)	none
»»» sales_hour	[object]	true	none	Hourly Sales Statistics	none
»»»» sold_hour	string	true	none	Sales Time	UTC time
»»»» income	number	true	none	Estimated Sales Revenue	none
»»»» sales	integer	true	none	Sales Volume	none
»»»» income_usd	number¦null	true	none	Revenue (USD)	none
»» sales_today	object	false	none	Today's Sales Statistics	none
»»» sales_hour	[object]	true	none	Hourly Sales Statistics	none
»»»» sold_hour	string	true	none	Sales Time	UTC time
»»»» income	number	true	none	Estimated Sales Revenue	none
»»»» sales	integer	true	none	Sales Volume	none
»»»» income_usd	number¦null	true	none	Estimated Sales 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 Details
Request Method: GET
API URL: /open-api/v1/sales-monitor-task/detail
Usage Note: Free