Skip to content

A meter trap was detected

POST

Delivered as a CloudEvents 1.0 envelope whose data is a MeterObservation. Batched ≤ 20 per delivery as a JSON array; signed with Sweep-Signature.

Media typeapplication/json
Array
object
specversion
required
string
Allowed values: 1.0
id
required

Prefixed ULID (evt_…)

string
/^evt_[0-9A-HJKMNP-TV-Z]{26}$/
source
required
type
required

Event type from events.json, e.g. sweep.execution.completed

string
time
required
string format: date-time
subject

Primary resource id

string
datacontenttype
string
Allowed values: application/json
data
required
object
key
additional properties
sweepsimulated

CloudEvents extension: true in developer test mode.

boolean
type
required
Allowed value: sweep.intel.meter.detected
data
required
object
id
required

Prefixed ULID (mtr_…)

string
/^mtr_[0-9A-HJKMNP-TV-Z]{26}$/
service
required
string
serviceDomain
One of:
string
basePriceCents
One of:
integer
billingPeriod
required
string
Allowed values: weekly monthly quarterly annual usage one_time unknown
includedAllowance
One of:
string
meterUnit
One of:
string
meterRate
One of:
string
observedUsage
One of:
string
observedOverageCents
One of:
integer
currentPeriodCostCents
One of:
integer
projectedPeriodCostCents
One of:
integer
previousPeriodCostCents
One of:
integer
changeCents
One of:
integer
changePercent
One of:
number
primaryDriver
One of:
string
concentration
One of:
string
nextThresholdCents
One of:
integer
projectedThresholdAt
One of:
string format: date-time
trapType
required
string
Allowed values: metered_overage teaser_expiration renewal_jump free_credit_exhaustion seat_growth auto_upgrade surcharge variable_bill unknown
action
required
string
Allowed values: watch set_limit explain ignore intervene
interventionCapable
required
boolean
evidenceLevel
required

CONFIRMED = direct platform/API/settlement evidence; DETECTED = reliable statement/email/invoice evidence; ESTIMATED = calculation from observable rates or incomplete evidence. An estimate is never presented as confirmed.

string
Allowed values: CONFIRMED DETECTED ESTIMATED
confidence
required
number
evidence
required
Array<object>
object
kind
required
string
Allowed values: email statement api invoice contract receipt user derived
ref
required
string
sourceId
string
observedAt
required
string format: date-time
excerpt
string
<= 300 characters
lastUpdated
required
string format: date-time

Acknowledge with any 2xx within 10 seconds