İçeriğe geç
Esc
Sonuç bulunamadı.

Bu sayfanın Türkçe çevirisi henüz tamamlanmadı, bu yüzden İngilizce dilinde görüntülemektisiniz.

List Logs

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

DateMath Reference
:

If you are familiar with Elasticsearch, Kibana, or Grafana date math queries, PlusAuth follows the same concepts. A date math expression starts with an anchor date, which can be either now or a date string ending with ||. The anchor date can optionally be followed by one or more math expressions:

  • +1h: Add one hour
  • -1d: Subtract one day
  • /d: Round down to the nearest day The supported units are:
Time UnitDuration
yYears
MMonths
wWeeks
dDays
hHours
HHours
mMinutes
sSeconds

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

ExpressionDescriptionResolves To
now+1hnow in milliseconds plus one hour2001-01-01 13:00:00
now-1hnow in milliseconds minus one hour2001-01-01 11:00:00
now-1h/dnow in milliseconds minus one hour, rounded down to UTC 00:002001-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

Additional query in PlusAuth Query Language format.

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

Mevcut Değerler: errorwarninginfo

GET
/logs
cURL
cURLC#DartGoJavaJavaScriptPHPPythonRubyRustSwift
1
2
3
Loading...
Response
200
Loading...

Response Body Schema

length
number
Zorunlu

The number of log entries returned in the current response.

limit
number
Zorunlu

The maximum number of log entries returned in a single response.

offset
number
Zorunlu

The page offset used for pagination. This value determines how many pages of results are skipped before returning logs.

total
number
Zorunlu

An estimated total number of log entries that match the query conditions, ignoring pagination.

interval
number

The duration of each aggregation bucket, expressed in milliseconds, used to group log data over the selected time range. Returned only for the first page (offset = 0)

logs
array<object>

The list of log entries matching the query conditions for the requested page. Ordered by time in descending order (newest first).

logs.
client_address
string
Zorunlu

IP address of the client that initiated the request

logs.
event_type
string
Zorunlu

Numeric code identifying the specific type of event that occurred

logs.
level
string
Zorunlu

Log level indicating the severity of the event

logs.
message
string
Zorunlu

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

logs.
request_id
string
Zorunlu

UUID identifying the specific request that generated this log entry

logs.
time
string
Zorunlu

Timestamp when the log event occurred in ISO format

logs.
user_id
string
Zorunlu

Unique identifier for the user associated with this event

logs.
details
object
Zorunlu

Additional details specific to the log event

stacked
array<object>

Aggregated log counts grouped by time interval and log level, intended for building stacked or time-series visualizations. Returned only for the first page (offset = 0)

stacked.
count
number
Zorunlu

The number of log entries that fall into this interval and severity level.

stacked.
interval
string
Zorunlu

The start time of the aggregation interval this data point represents.

stacked.
level
string
Zorunlu

The log severity level associated with this aggregation bucket.