Skip to main content
GET
Get Item Usage

Authorizations

X-Api-Key
string
header
required

API key for authentication

Query Parameters

enableHypeFor
string

A monitor name, such as walmart. Previews your usage with Hyped automation turned on for that monitor.

Response

Current or prospective monitor usage

unlimitedItems
boolean

True if the workspace has no item limit.

totalMonitoredItems
integer

Items that count toward your limit.

totalListItems
integer

Items on your lists.

totalHypedProducts
integer

Hyped items you get alerts for.

totalHypedSites
integer

Sites with Hyped automation on.

monitorLimit
integer

The most items your plan allows.

allowed
boolean

True if the usage fits within your limit.