Skip to main content

API request log

The API request log screen displays the history of API requests.

Accessing the screen

In the left sidebar menu, click [Operation] -> [Log management].
Image from Gyazo

Click [Log management] above the page title, and select [API request log] in the dropdown menu.
Image from Gyazo

Field descriptions

Image from Gyazo

Filter conditions

You can filter the logs easily using the endpoint, log date and time search, and advanced search functions.

Enter the endpoint related to the log you want to search.
Narrows down API requests that match the endpoints entered.
Image from Gyazo

Select a period based on the start and end time of the log. Refine the logs within the selected period.
The selectable period for the logs is 35 days. When specifying past log dates and times, please ensure that they fall within the 35-day range.
Image from Gyazo

You can create refinements by clicking the "Advanced Search" button and setting different filter conditions.
Image from Gyazo

The following options are available:

FieldDescriptionSpecifiable conditions
Log levelLog level indicating the importance of the message.Available search operations
EndpointURI of the endpoint where the request was sent.Available search operations
HTTP response status code HTTP response status code of the request.Available search operations
ParametersParameters given to the request.Available search operations
ResponseHTTP response.Available search operations
Member IDMember ID of the user who attempted the access.Available search operations
Application request IDUnique request ID used by Kuroco.Available search operations

The advanced search function allows you to concatenate multiple conditions using AND or OR.

  • AND: Returns only data matching all the specified conditions in your search.
  • OR: Returns data matching any of your specified conditions.
Available search operations

You can specify the following operations in the search conditions:

OperationInput typeReturned data
containsText stringEntries matching part of the search term.
not containsText stringEntries not matching any part of the search term.
=Alphanumeric stringEntries exactly matching the search term.
!=Alphanumeric stringEntries not exactly matching the search term.
<Alphanumeric stringEntries less than the search term.
>Alphanumeric stringEntries greater than the search term.
<=Alphanumeric stringEntries less than or equal to the search term.
>=Alphanumeric stringEntries greater than or equal to the search term.
starts withText stringEntries beginning with the search term.
not starts withText stringEntries not beginning with the search term.  
ends withText stringEntries ending with the search term.
not ends withText stringEntries not ending with the search term.
inAlphanumeric stringEntries matching any of the search terms (for multiple search terms only).
not inAlphanumeric stringEntries not matching any of the search terms (for multiple search terms only).
Sort

Under "Sort", you can specify the sort key and display order of the search results.

  • ASC: Ascending, from oldest to newest.
  • DESC: Descending, from newest to oldest.

Log entries

The columns displayed for the log entries are as follows:

ColumnDescription
TimestampDate and time the log was recorded.
Log levelLog level indicating the importance of the message. See: Log levels below for details.
EndpointURI of the endpoint where the request was sent.
HTTP response status code HTTP response status code of the request.
ParametersParameters given to the request.
ResponseHTTP response.
Member IDMember ID of the user who attempted the access.
Application request IDUnique request ID used by Kuroco.

Log levels

Logs can be categorized into the 9 levels below, listed in order of increasing importance:

  • Default
  • Debug
  • Info
  • Notice
  • Warning
  • Error
  • Critical
  • Alert
  • Emergency

Buttons

Image from Gyazo

ButtonDescription 
SearchSearch based on the above settings.  
DownloadDownload a list of the displayed logs.
DeleteDelete a list of the displayed logs.

Log list download

After click [Download] button, the download settings will open. Image from Gyazo

Field(s)Description 
CharsetCharacter encoding of the output CSV file.
CancelCancel downloading.
DownloadExecute downloading.

Support

If you have any other questions, please contact us or check out Our Slack Community.