Skip to content
events/
Get a list of events

Elevate Events API (1.0)

Events

This API provides read-only access to time-based events recorded within Elevate. Example events include;

  • A user has logged in
  • A user has been locked out due to reaching a maximum number of failed login attempts
  • A role has been created

The initial release of this API contains only security-related events. Over time this API will evolve to include events from elsewhere in the system e.g.

  • A bill run has been closed
  • Invoices have been distributed
  • A customer has been created
Download OpenAPI description
billing-rest-events.json
billing-rest-events.yaml
Languages
Servers
https://rest.elevatebilling.com/v1

events

Access to time-based events recorded within Elevate

Operations

Get a list of events

Request

Security
bearerAuth
Query
pageinteger(int32)(PageParam)>= 1required

Page of results to show

Example: page=1
pageSizeinteger(int32)(ResultsPerPageParam)[ 1 .. 1000 ]required

Results to return per page

Example: pageSize=100
sortstring(SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fieldsstring(FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
categorystring(StringFilterParam)

Filter by event category

Example: category=xyz | in:x,y | like:xyz
actionstring(StringFilterParam)

Filter by the action in the event

Example: action=xyz | in:x,y | like:xyz
createdFromstring(DateTimeFilterParam)required

Filter by events created after this timestamp

Example: createdFrom=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
createdTostring(DateTimeFilterParam)required

Filter by events created before this timestamp

Example: createdTo=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/events?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&category=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&action=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&createdFrom=yyyy-MM-ddTHH%3Amm%3AssZ+%2C+lt%3Ayyyy-MM-ddTHH%3Amm%3AssZ+%2C+gt%3Ayyyy-MM-ddTHH%3Amm%3AssZ&createdTo=yyyy-MM-ddTHH%3Amm%3AssZ+%2C+lt%3Ayyyy-MM-ddTHH%3Amm%3AssZ+%2C+gt%3Ayyyy-MM-ddTHH%3Amm%3AssZ' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)read-only

Event ID

Example: 1
timestampstring(date-time)required

Timestamp when the event was created

categorystring[ 1 .. 100 ] characters[a-zA-Z0-9_-]+required

Category of the event

Example: "authentication"
actionstring[ 1 .. 100 ] characters[a-zA-Z0-9_-]+required

The action performed by the user

Example: "user-login-success"
descriptionstring[ 1 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Textual description of the event

Example: "User bob.smith has logged in"
usernamestring[ 1 .. 100 ] characters

The username associated with the event

Example: "bob.smith"
ipAddressstring(ipv4)

The IP address associated with the event

Example: "12.34.56.78"
]
Response
application/json
[
  {
    "id": 1,
    "timestamp": "2019-08-24T14:15:22Z",
    "category": "authentication",
    "action": "user-login-success",
    "description": "User bob.smith has logged in",
    "username": "bob.smith",
    "ipAddress": "12.34.56.78"
  }
]