​
Purpose

The Products API provides functionality for searching and discovering products within our monitoring system. This allows you to find specific products by their identifiers before adding them to your monitoring lists.

​
Query Parameters

All endpoints require the site parameter, which specifies the monitor name. A list of available monitors can be found using the Monitor Sites endpoint.

​
Response Body

The response from the API contains two main parts:
  • site: An object that contains information about the site being queried.
  • results: An object with product IDs as keys and result objects as values.

​
Site Object

The site object contains detailed information about the monitoring site, including supported features and configuration options.

​
Results Object

Each result in the results object has the following structure:
FieldTypeDescription
errorBooleanIndicates if an error occurred
statusStringDetailed status indicating error/success
productObjectProduct object with detailed information

​
Product Object

The product object contains comprehensive product information including:
  • Product SKU/identifier
  • Product name and description
  • Current price and currency
  • Product images
  • Product URL
  • Site information
  • Offer ID for tracking
  • Restock timestamps
  • First added timestamp