Your suggested change has been received. Thank you.

close

Logs Config API (0.0.1)

Download OpenAPI specification:Download

Logs Config API documentation

Logs Config API

Logs API

List log records

Lists log records based on the specified filter criteria.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

query Parameters
start
string
Example: start=2019-05-13T15:43:13.022Z

A datetime (ISO-8601 format) to request the log records starting from a defined moment in time. start must lie before end. start cannot be combined with last.

end
string
Example: end=2019-05-13T16:43:13.022Z

A datetime (ISO-8601 format) to request the log records up to a defined moment in time. start must lie before end. end cannot be combined with last.

last
string
Example: last=2019-05-13T15:43:13.022Z

A duration (ISO-8601 format) to request the most recent log records for a defined period of time. last cannot be combined with start or end.

next
string

A token, obtained in a previous query, to request the next batch of records (pagination). This parameter can only be added if the previous query's response contained a next token. The other query parameters must be identical to the original request.

uuid
string

The identifier of a user to request the log records for that specific user.

accountIdentifier
string

A unique property of a user to request the log records for that specific user. The unique property can be an email address or phone number.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "startTime": "string",
  • "endTime": "string",
  • "next": "string",
  • "logs": [
    ]
}

List log records

Lists log records based on the specified filter criteria.

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

query Parameters
start
string
Example: start=2019-05-13T15:43:13.022Z

A datetime (ISO-8601 format) to request the log records starting from a defined moment in time. start must lie before end. start cannot be combined with last.

end
string
Example: end=2019-05-13T16:43:13.022Z

A datetime (ISO-8601 format) to request the log records up to a defined moment in time. start must lie before end. end cannot be combined with last.

last
string
Example: last=2019-05-13T15:43:13.022Z

A duration (ISO-8601 format) to request the most recent log records for a defined period of time. last cannot be combined with start or end.

next
string

A token, obtained in a previous query, to request the next batch of records (pagination). This parameter can only be added if the previous query's response contained a next token. The other query parameters must be identical to the original request.

uuid
string

The identifier of a user to request the log records for that specific user.

accountIdentifier
string

A unique property of a user to request the log records for that specific user. The unique property can be an email address or phone number.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "startTime": "string",
  • "endTime": "string",
  • "next": "string",
  • "logs": [
    ]
}