Close menu
Explore Plans
Mobile menu Close menu
Agile Octopus

Energy Consumed By Period

This trigger activates when the energy consumed during a specified period exceeds a user-defined threshold. Users can configure the period type (daily, weekly, or monthly) and set a consumption threshold.

Developer info

API endpoint slug
agile_octopus.energy_consumed_by_period

Trigger fields

Consumption threshold Text input

Label
Consumption Threshold
Helper text
Specify the energy consumption threshold in kWh (e.g., 100).
Slug
consumption_threshold
Required
true
Can have default value
true

Period type Dropdown list

Label
Period Type
Helper text
Choose the period type for evaluation (daily, weekly, or monthly).
Slug
period_type
Required
true
Can have default value
false

Tariff Dropdown list

Label
Tariff
Helper text
Select your personal or standard electricity import tariff. Only supported dynamic tariffs (like Agile) are allowed.
Slug
tariff
Required
true
Can have default value
false

Ingredients

Created at Date and time event was created.

Slug
created_at
Filter code
AgileOctopus.energyConsumedByPeriod.CreatedAt
Type
Date with time (ISO8601)
Example
2020-07-08T04:17:06+05:00

Expected consumption threshold The threshold value for energy consumption.

Slug
expected_consumption_threshold
Filter code
AgileOctopus.energyConsumedByPeriod.ExpectedConsumptionThreshold
Type
String
Example
100

Energy consumed The total energy consumed during the specified period.

Slug
energy_consumed
Filter code
AgileOctopus.energyConsumedByPeriod.EnergyConsumed
Type
String
Example
100

Period type The type of period used for grouping data.

Slug
period_type
Filter code
AgileOctopus.energyConsumedByPeriod.PeriodType
Type
String
Example
daily

Date from The start date of the evaluated period.

Slug
date_from
Filter code
AgileOctopus.energyConsumedByPeriod.DateFrom
Type
Date with time (ISO8601)
Example
2020-07-08T04:17:06+05:00

Date to The end date of the evaluated period.

Slug
date_to
Filter code
AgileOctopus.energyConsumedByPeriod.DateTo
Type
Date with time (ISO8601)
Example
2020-07-08T04:17:06+05:00

Triggered at The timestamp when the trigger was activated.

Slug
triggered_at
Filter code
AgileOctopus.energyConsumedByPeriod.TriggeredAt
Type
Date with time (ISO8601)
Example
2020-07-08T04:17:06+05:00