List Logs

Query over every log generated by PlusAuth belongs to your tenant.

DateMath Reference :

If you are used to ElasticSearch, Kibana or Grafana date math queries, than you can ignore this section as PlusAuth includes same characteristics with them. The expression starts with an anchor date, which can either be now, or a date string ending with ||. This anchor date can optionally be followed by one or more maths expressions:

+1h: Add one hour
-1d: Subtract one day
/d: Round down to the nearest day The supported units are:

Time Unit	Duration
`y`	Years
`M`	Months
`w`	Weeks
`d`	Days
`h`	Hours
`H`	Hours
`m`	Minutes
`s`	Seconds

Assuming now is 2001-01-01 12:00:00, some examples are:

Expression	Description	Resolves To
`now+1h`	`now` in milliseconds plus one hour	`2001-01-01 13:00:00`
`now-1h`	`now` in milliseconds minus one hour	`2001-01-01 11:00:00`
`now-1h/d`	`now` in milliseconds minus one hour, rounded down to UTC 00:00	`2001-01-01 00:00:00`

Scopes

read:log

Query Parameters

from
string

Filter logs occurred after this date. This can be a datetime string or date math expression.

include_api
boolean

Set true to include REST API logs

limit
number

min-1

max

500

Limit the number of results returned

Examples: 5

offset
number

min0

max

99999999999999

Page number of records you wish to skip before selecting records. Final skipped records count would be limit * offset.

operation
string

Retrieve logs belongs to one or more operation. Comma separated. Ex.: authorization.error,create.user

q
string

Filter logs occurred until this date. This can be a datetime string or date math expression.

to
string

Filter logs occurred until this date. This can be a datetime string or date math expression.

type
string

Type/s of logs to be retrieved. Comma separated. Comma separated. Ex.: error,warning,info

Available Values: errorwarninginfo

200

Response Body Schema

interval
string | integer

logs
array<object>

logs.
client_address
string
Required

IP address of the client that initiated the request

logs.
event_type
string
Required

Numeric code identifying the specific type of event that occurred

logs.
level
string
Required

Log level indicating the severity of the event

logs.
message
string
Required

Human-readable message describing the event (may be empty)

logs.
request_id
string
Required

UUID identifying the specific request that generated this log entry

logs.
time
string
Required

Timestamp when the log event occurred in ISO format

logs.
user_id
string
Required

Unique identifier for the user associated with this event

logs.
details
object
Required

Additional details specific to the log event

List Logs

DateMath Reference :

Query Parameters

from
string

include_api
boolean

limit
number

offset
number

operation
string

q
string

to
string

type
string

Response Body Schema

interval
string | integer

logs
array<object>

logs.
client_address
string
Required

logs.
event_type
string
Required

logs.
level
string
Required

logs.
message
string
Required

logs.
request_id
string
Required

logs.
time
string
Required

logs.
user_id
string
Required

logs.
details
object
Required

stacked
array<object>

stacked.
count
string | integer
Required

stacked.
interval
string
Required

stacked.
level
string
Required

List Logs

DateMath Reference :

Query Parameters

fromstring

include_apiboolean

limitnumber

offsetnumber

operationstring

qstring

tostring

typestring

Response Body Schema

intervalstring | integer

logsarray<object>

logs. client_addressstringRequired

logs. event_typestringRequired

logs. levelstringRequired

logs. messagestringRequired

logs. request_idstringRequired

logs. timestringRequired

logs. user_idstringRequired

logs. detailsobjectRequired

stackedarray<object>

stacked. countstring | integerRequired

stacked. intervalstringRequired

stacked. levelstringRequired

from
string

include_api
boolean

limit
number

offset
number

operation
string

q
string

to
string

type
string

interval
string | integer

logs
array<object>

logs.
client_address
string
Required

logs.
event_type
string
Required

logs.
level
string
Required

logs.
message
string
Required

logs.
request_id
string
Required

logs.
time
string
Required

logs.
user_id
string
Required

logs.
details
object
Required

stacked
array<object>

stacked.
count
string | integer
Required

stacked.
interval
string
Required

stacked.
level
string
Required