API log

The API log screen displays the API request history.

Accessing the screen

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

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

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].

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

The following input options are available:

Field	Description	Specifiable conditions
Date	Date and time the log was recorded.	Date and time range specification
cache_status	Indicates if this request was served by a cache.	Cache status
request	HTTP method of the request.	Available search operations
status	HTTP response status code for the request.	Available search operations
uri	URI of the endpoint that sent the request.	Available search operations
client_ip	IP address of the user making the request.	Available search operations
api_access_token	Authentication token passed along with the request.	Available search operations
execution_time	Time taken by the server to process the request in seconds.	Available search operations (numeric input only)
body_size	Response body size in bytes.	Available search operations (numeric input only)
request_referer	Address of the webpage immediately before the currently requested page.	Available search operations
request_user_agent	User agent requesting the API.	Available search operations
geo_city	Location information of the user making the request.	Available search operations
geo_country_code	Country code of the user making the request.	Available search operations
rcms_request_id	Unique request ID used by Kuroco.	Available search operations
request_id	Unique request ID used by Fastly.	Available search operations

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

The following date and time input options are available:

You can specify the following operations in the search conditions:

Operation	Input type	Returned data
`contains`	Text string	Entries matching part of the search term.
`not contains`	Text string	Entries not matching any part of the search term.
`=`	Alphanumeric string	Entries exactly matching the search term.
`!=`	Alphanumeric string	Entries not exactly matching the search term.
`<`	Alphanumeric string	Entries less than the search term.
`>`	Alphanumeric string	Entries greater than the search term.
`<=`	Alphanumeric string	Entries less than or equal to the search term.
`>=`	Alphanumeric string	Entries greater than or equal to the search term.
`starts with`	Text string	Entries beginning with the search term.
`not starts with`	Text string	Entries not beginning with the search term.
`ends with`	Text string	Entries ending with the search term.
`not ends with`	Text string	Entries not ending with the search term.
`in`	Alphanumeric string	Entries matching any of the search terms (for multiple search terms only).
`not in`	Alphanumeric string	Entries not matching any of the search terms (for multiple search terms only).

*Only numerical operations are allowed for execution_time and body_size.

Under "Order", you can specify the display order of the search results.

Sort key options:

The columns displayed for the log entries are as follows:

Column	Description
timestamp	Date and time the log was recorded.
cache_status	Indicates if the request was served by a cache. See: Cache status below for details.
request	HTTP method of the request.
status	HTTP response status code for the request.
response	API response message.
uri	URI of the endpoint that sent the request.
client_ip	IP address of the user making the request.
api_access_token	Authentication token passed with the request.
execution_time	Time taken by the server to process the request in seconds.
body_size	Response body size in bytes.
request_referer	Address of the webpage immediately before the currently requested page.
request_user_agent	User agent requesting the API.
geo_city	Location information of the user making the request.
geo_country_code	Country code of the user making the request.
io_info	Image optimizer data from Fastly.
request_id	Unique request ID used by Fastly.
rcms_request_id	Unique request ID used by Kuroco.

The cache status can take one of the values below:

Value	Description
HIT	Request was received from a cache.
MISS	Request reached the server and no cache was found.
PASS	Request could not be cached.
ERROR	An error occurred during caching.

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