API Documentation
Overview
Response Body
The responses obtained from the unlisted/stream
endpoint will consist of an object with the following structure:
Field | Type | Description | Always Present |
---|---|---|---|
site | Object | A site object containing site info | No |
notificationType | String | Type of the notification | No |
product | Object | A product object for product events | Yes |
isFiltered | Boolean | A boolean flag that indicates if event is filtered | Yes |
isHyped | Boolean | A boolean flag that indicates if event is hyped | Yes |
instore | Object | An instore object for instore events | Yes |
antibot | Object | An antibot object for antibot events | Yes |
Site Object
The site
object is defined here.
Instore Object
The instore
object is defined here.
Antibot Object
The antibot
object is defined here.
Product Object
The product
object is defined here.