API log

The API log screen displays the API request history.

Accessing the screen

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

Image from Gyazo

Click the [Log management] link above the page title, and select [API logs] in the dropdown menu.

Image from Gyazo

Field descriptions

Image from Gyazo

Filter conditions

You can filter the logs easily using the URI search and advanced search functions.

Enter the target URI in the search box and click [Search].

Image from Gyazo

Click the [Advanced search] button to input advanced filter conditions.

Image from Gyazo

The following input options are available:

FieldDescriptionSpecifiable conditions
TimestampDate and time the log was recorded.Date and time range specification
Cache statusIndicates if this request was served by a cache.Cache status
HTTP methodHTTP method of the request.HTTP method
StatusHTTP response status code for the request.HTTP status
URIURI of the endpoint that sent the request.Available search operations
Client IP addressIP address of the user making the request.Available search operations
API access tokenAuthentication token passed along with the request.Available search operations
Execution timeTime taken by the server to process the request in seconds.Available search operations (numeric input only)
Body sizeResponse body size in bytes.Available search operations (numeric input only)
RefererAddress of the webpage immediately before the currently requested page.Available search operations
User agentUser agent requesting the API. Available search operations
CityLocation information of the user making the request. Available search operations
Country codeCountry code of the user making the request. Available search operations
Application request IDUnique request ID used by Fastly.Available search operations
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.
Date and time range specification

The following date and time input options are available:

  • Date range
  • Relative
  • Time range
  • Datetime range
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).

*Only numerical operations are allowed for execution_time and body_size.

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.

Sort key options:

  • Date
  • cache_status
  • request
  • status
  • execution_time
  • body_size

Log entries

The columns displayed for the log entries are as follows:

ColumnDescription
TimestampDate and time the log was recorded.
Cache statusIndicates if the request was served by a cache. See: Cache status below for details.
HTTP method HTTP method of the request. See: HTTP method below for details.
StatusHTTP response status code for the request. See: HTTP status below for details.
ResponseAPI response message.
URI URI of the endpoint that sent the request.
Client IP addressIP address of the user making the request.
API access tokenAuthentication token passed with the request.
Execution timeTime taken by the server to process the request in seconds.
Body size Response body size in bytes.
Referer Address of the webpage immediately before the currently requested page.
User agentUser agent requesting the API.
CityLocation information of the user making the request.
Country codeCountry code of the user making the request.
IO info Image optimizer data from Fastly.
Request idUnique request ID used by Fastly.
Application request ID Unique request ID used by Kuroco.

Cache status

The cache status can take one of the values below:

ValueDescription
HITRequest was received from a cache.
MISSRequest reached the server and no cache was found.
PASSRequest could not be cached.
ERRORAn error occurred during caching.

HTTP method

  • GET
  • POST
  • HEAD

HTTP status

  • OK
  • Accepted
  • Partial Content  
  • Moved Permanently  
  • Moved Temporarily  
  • Bad Request  
  • Unauthorized  
  • Forbidden  
  • Not Found  
  • Method Not Allowed  
  • Unprocessable Entity  
  • Internal Server Error  
  • Bad Gateway  
  • Service Unavailable  
  • Gateway Time-out

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.

If you have any other questions, please use our contact form or Slack workspace.