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

Click the [Log management] link above the page title, and select [API analytics] 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-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 (fetched from Gyazo)

The following input options are available:

FieldDescriptionSpecifiable conditions
DateDate and time the log was recorded.Date and time range specification
URLAccessed page URL.Available search operations
HitNumber of times the request was made.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)
cache_statusIndicates if this request was served by a cache.Cache status
api_idName(s) of the requesting API(s).In / not in dropdown list selection
api_uri_idURI path(s) of the requesting API(s).In / not in dropdown list selection

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.

Display order

Under "Order", you can specify the 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_idName of the requesting API.
requestHTTP method of the request.
api_uri_idURI path of the requesting API.
cache_statusIndicates if this request was served by a cache. See: Cache status below for details.
statusHTTP response status code for the request.
hitNumber of times the request was made.
execution_timeTime taken by the server to process the request in seconds.
body_sizeResponse 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.

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