API log

The API log screen displays the API request history.

Accessing the screen

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

Image (fetched from Gyazo)

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

Image (fetched from Gyazo)

Field descriptions

Image (fetched 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 (fetched from Gyazo)

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

Image (fetched from Gyazo)

The following input options are available:

FieldDescriptionSpecifiable conditions
DateDate and time the log was recorded.Date and time range specification
cache_statusIndicates if this request was served by a cache.Cache status
requestHTTP method of the request.Available search operations
statusHTTP response status code for the request.Available search operations
uriURI of the endpoint that sent the request.Available search operations
client_ipIP 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)
request_refererAddress of the webpage immediately before the currently requested page.Available search operations
request_user_agentUser agent requesting the API.Available search operations
geo_cityLocation information of the user making the request.Available search operations
geo_country_codeCountry code of the user making the request.Available search operations
rcms_request_idUnique request ID used by Kuroco.Available search operations
request_idUnique request ID used by Fastly.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.

Display order

Under "Order", you can specify the 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.
requestHTTP method of the request.
statusHTTP response status code for the request.
responseAPI response message.
uriURI of the endpoint that sent the request.
client_ipIP 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_sizeResponse body size in bytes.
request_refererAddress of the webpage immediately before the currently requested page.
request_user_agentUser agent requesting the API.
geo_cityLocation information of the user making the request.
geo_country_codeCountry code of the user making the request.
io_infoImage optimizer data from Fastly.
request_idUnique request ID used by Fastly.
rcms_request_idUnique 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.

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