API logs

Created: 02.08.2023

Updated: 11.12.2023

Author: Anastasia N.

To view API logs, you need to go to Settings → API logs.

Logs Viewing Screen Structure

  1. Search for a request by its content. Entities available for search are displayed in the dropdown menu:

  1. Data refresh button;

  2. Bar chart showing the number of requests for the selected period. It displays the total number of requests for the period and count per day.

  3. Select a time range for viewing logs.

Available ranges:

  • Today

  • Yesterday

  • Last 3 days

  • Last 7 days

  • Last 14 days

  • Last 30 days

  • Custom Range

You can also specify the start and end time of the selected period:

As a custom range, you can select a period of up to 144 days

Logs are shown according to the time-zone of your section.

  1. Filter logs by request status. Only the statuses corresponding to the requests within the chosen time range are available.

  2. Filter logs by the endpoint to which the requests were sent. Only the endpoints to which requests were sent within the chosen time range are available.

  3. Filter logs by the types of events specified in the requests. Selects only requests sent to the /ssapi/events endpoint. Only event types specified in the requests within the chosen time range are available.

  4. Filter logs by the server-side request execution time. You can specify minimum and/or maximum durations in milliseconds.

  5. Select the columns displayed in the table.

Available parameters:

Parameter
Value

Endpoint

The endpoint to which the request was sent.

User ID

User ID assigned by Gravity Field (slid).

SessionId

Session ID assigned by Gravity Field.

CustomSessionId

Custom session identifier specified in the request.

Status

Status (code) of the request: 200, 422, etc.

Timestamp

Timestamp of the request.

Request Duration

Request execution time on the server side.

  1. View the request and response bodies. To view, click on the row with the request information. The request body and response to the given request (if applicable for the opened request) will appear in a pull-out panel.

Last updated

Was this helpful?