Monitor
Overview
Site monitoring information
Purpose
The Monitor API provides information about available monitoring sites and their capabilities. This endpoint allows you to discover which e-commerce platforms are supported and their specific features.
Response Body
The /monitor/sites endpoint returns a JSON object that contains all supported sites, organized by platform. Each platform is represented as a key, with an array of Site objects as its value.
Site Object
The site object contains detailed information about each monitoring site:
| Field | Type | Description |
|---|---|---|
| platformName | String | The name of the platform (e.g., amazon) |
| siteName | String | The name of the site (e.g., AmazonUS) |
| siteUrl | String | The URL of the site |
| siteCurrency | String | The currency used on the site |
| siteImg | String | An image URL for the site |
| hasLists | Boolean | Whether the site supports monitoring lists |
| hasProducts | Boolean | Whether the site supports product search |
| hasReleases | Boolean | Whether the site has release monitoring |
| hasForceAdd | Boolean | Whether the site supports force adding products |
| queryType | String | The type of query used (productSku or productUrl) |
| restockTypes | Array | An array of restock types supported by the site |
| altNames | Array | An array of alternative names for the site |
Usage
Use this endpoint to:
- Discover available monitoring sites
- Check site capabilities before making other API calls
- Get the correct site identifiers for use in other endpoints
- Understand what features are available for each platform