Purpose
Provides functionality for managing product lists. This includes the ability to add products to lists, remove products from lists, and check the contents of lists.
Query Parameters
All endpoints require the site parameter, which specifies the monitor name. A list of available monitors can be found in our Guidebook.
Response Body
The response from the API contains two main parts:
site: An object that contains information about the site being queried.results: An array of objects that contain information about the products returned by the query.
Site Object
The site object is defined here.
Results Array
The results array contains objects that have the following fields:
| Field | Type | Description |
|---|---|---|
| error | boolean | Indicates if an error occurred |
| status | string | Detailed status indicating error/success |
| product | object | Product object |
Product Object
The product object is defined here.