API analytics

The API analysis screen displays statistics such as cache hits and execution times for each API request made on the site.

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-based 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 from Gyazo

The following input options are available:

FieldDescriptionSpecifiable conditions
Timestamp Date and time the log was recorded.
URLURL of the page accessed.Available search operations
HitThe number of hits on a request. Available search operations
Execution timeTime taken by the server to process the request in seconds. Available search operations
Body sizeResponse body size in bytes. Available search operations
Cache statusIndicates if this request was served by a cache.Cache status
API IDAPI ID. Available search operations
API URI IDAPI URI ID. 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 use the following operations in applicable 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 / smallest to largest.
  • DESC: Descending, from newest to oldest / largest to smallest.

Sort key options:

  • Hit
  • execution_time
  • body_size
  • cache_status
  • api_id
  • api_uri_id

Log entries

The columns displayed for the log entries are as follows:

ColumnDescription
API IDAPI ID.
HTTP method HTTP method of the request.
API URI IDAPI URI ID.
Cache statusIndicates if the request was served by a cache. See: Cache status below for details.
StatusHTTP response status code for the request.
HitDisplays the number of hits on a request.
Execution timeTime taken by the server to process the request in seconds.
Body size Response body size in bytes.

Cache status

The cache status can take one of the values below:

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

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.