Event APIIngest

Get a list of events for provided filters

Requires the METER_DATA.VIEW permission.

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1
version

Headers

x-platform-idstringOptional
Platform ID.

Query parameters

customer_idstringOptional
The resource id of the customer.
referencestringOptional
The reference of the ingest.
meter_idstringOptional
The resource id of the meter.
deletedbooleanOptional
Filter the response by deleted field value.
processed_details_typestringOptional

Filter the response by processing_details.type value. Ex.: NOT_MATCHED, DUPLICATE

expand[]list of stringsOptional
The id fields of the resources that are going to be expanded.
limitintegerOptional
The amount of records shown in the list
pageintegerOptional
The page which is going to be shown

Response

OK
datalist of objects
pageinteger or null
limitinteger or null
total_number_of_pagesinteger or nullDeprecated

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error