Overview - Docs

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`	Monitor platform identifier, such as `amazon`
`siteType`	`String`	Site category, such as `retail`
`siteId`	`String`	Stable site identifier, usually the domain
`siteName`	`String`	Display name, such as `AmazonUS`
`siteUrl`	`String`	Site URL
`siteCurrency`	`String`	Currency used by the site
`routingGroup`	`String`	Optional market routing group, such as `US` or `EU`
`capabilities`	`SiteCapabilities`	Workflows supported by this site
`queryType`	`String`	Expected query type, such as `productSku` or `productUrl`
`notificationTypes`	`Array<String>`	Notification types emitted by the site
`altNames`	`Array<String>`	Alternative site names
`platformCategories`	`Array<String>`	Packages or categories containing the site
`sellers`	`Array<String>`	Seller identifiers supported by the site

Site images are derived from siteId; the API no longer returns a siteImg field. SiteCapabilities contains the boolean fields lists, products, releases, forceAdd, and sellers. The sellers array remains the site configuration; capabilities.sellers declares whether seller-specific monitoring is supported.

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