HomepageBlog

Logs

List all logs

get

API Key Scope: logs / index

Authorizations
Query parameters
limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

sort_bystring[]Optional

Sort results by attribute.

Can sort on multiple attributes, separated by |. Order direction can be suffixing the attribute by either :asc (default) or :desc.

degreestringOptional

Filter on degree

datestringOptional

Filter on date

messagestringOptional

Filter on message

is_a_notificationstringOptional

Lets know if the request should return all the logs or only the notifications

Responses
200

List of logs.

application/json
get
/logs
GET /api/v2/logs HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
200

List of logs.

{
  "count": 1,
  "logs": [
    {
      "date": "2022-01-01T10:48:08.000Z",
      "message": "this is a message",
      "degree": 10
    }
  ]
}

Clear all notifications

post

API Key Scope: logs / post

Authorizations
Responses
204

Log notifications clear

No content
post
/logs/clear_notifications
POST /api/v2/logs/clear_notifications HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
204

Log notifications clear

No content

Last updated

Was this helpful?