Skip to main content
GET
Get removed consumptions (depending on the provided site and filters)

Path Parameters

site-id
string
required

The site identifier

Query Parameters

minBeginTs
string

The minimal begin date, format ISO8601 (YYYY-MM-DDThh:mm:ssZ)

maxBeginTs
string

The maximal begin date, format ISO8601 (YYYY-MM-DDThh:mm:ssZ)

minEndTs
string

The minimal end date, format ISO8601 (YYYY-MM-DDThh:mm:ssZ)

maxEndTs
string

The maximal end date, format ISO8601 (YYYY-MM-DDThh:mm:ssZ)

challengeType
enum<string>

The challenge type

Available options:
PEAK_DAY,
REWARD_DAY,
SHIFT_DAY,
PERIOD,
MARATHON,
SPRINT,
VARIATION_CONSUMPTION_DAY,
REDUCE_CONSUMPTION_DAY,
OVER_CONSUMPTION_DAY

Response

Successful response

units
object
required

Units by type of consumption

removedConsumptions
object[]
required

The list of removed consumptions

aggregations
object[]
required

The list of removals aggregated by challenge type