Mutes
Overview
Purpose
Provides functionality for managing product mutes. This includes the ability to add products to mute, remove products from being muted, and get a list of products that are muted.
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.