Skip to main content

Search power events

Request

This endpoint returns all power events in a paginated way. Allows narrowing returned results by submitting additional query filters.

Results can be filtered by IBX, status, and collection date. Both limit and offset are required to control pagination.

Security
BearerAuth
Query
ibxArray of strings

List of IBX codes to filter power events (comma-separated)

Example:ibx=SV5,NY1
statusArray of strings

List of statuses to filter power events (comma-separated). Possible values - ACTIVE, INACTIVE

Items Enum:"ACTIVE""INACTIVE"
Example:status=ACTIVE
edgeCollectedOnstring

Date filter to retrieve power events collected after a specific date (ISO 8601 format)

Example:edgeCollectedOn=2024-01-01T00:00:00.000Z
limitintegerrequired

Number of records to retrieve per request

Example:limit=100
offsetintegerrequired

Record number to start retrieval from (0..N)

Example:offset=0
Payload
// No request payload

Responses

OK

Bodyapplication/json
itemsArray of objects(PowerEventReadModel)

Array of power events

limitinteger

Number of records returned per request

Example:100
offsetinteger

Starting record index for this page

Example:0
totalCountinteger

Total number of records matching the query

Example:42
Response
{ "items": [ { … } ], "limit": 100, "offset": 0, "totalCount": 42 }
Was this page helpful?