/logs/queries

This API endpoint allows users to submit a query to retrieve log data for a specific tenant. The clientId parameter represents the unique identifier of the tenant for which the log query is being executed. By sending a query in the request body, users can filter and search logs based on various criteria such as severity levels and specific log messages.

The request payload supports both query and advancedQuery parameters. You can use either query or advancedQuery in a single request. See Advanced Query Builder Syntax for more details.

Path Parameters

  • clientIdstringrequired

    Describes the client ID of the tenant.

Request Body

application/json

  • querystring

    The log query string used to filter logs based on specific conditions. Note: The request payload supports both query and advancedQuery parameters. You can use either query or advancedQuery in a single request.

  • advancedQuerystring

    The log advanced query string used to filter logs based on specific conditions. **Note:** The request payload supports both `query` and `advancedQuery` parameters. You can use either in a single request.

  • fieldsarray of strings

    The list of fields to be returned in the query result. If the fields parameter is left empty, all fields in the log record will be returned.

  • limitinteger

    The maximum number of log entries to return. The maximum limit that can be set is 1000.

  • startinteger

    The start timestamp for the query in nanoseconds.

  • endinteger

    The end timestamp for the query in nanoseconds.

Loading Examples...

Responses

  • resultsarray

  • nextStartinteger

    The timestamp for the next start point to query further logs.

  • nextEndinteger

    The timestamp for the next end point to query further logs.

Loading Examples...