Check the usage status of the Web API.

You can check the number of Web API requests, traffic volume, and over-limit status for 1 day and at 5-minute intervals.
Note that you need system administrator privileges to check the Web API usage status.

Check the usage status.

  1. Open the "API Management" tab in the admin console.
  2. Click the 'Display' button for "API Usage Status" to open the "API Usage Status" view.
../../../_images/img_01.en255.png

Check the Web API usage status for a day.

  1. Specify the date you wish to check. Initially displayed is the current day’s data.
../../../_images/img_02.en241.png
[1] Limit
Displays the number of API requests and traffic volume (in MB) that can be executed in one day.
[2] In use
Displays the number of executed API requests and traffic volume (in MB).
[3] Daily limit exceeded
Displays the number of requests that exceeded the daily limit.

Tip

  • Dates can be specified up to 60 days prior.
  • The numbers displayed as 'In use' may be delayed by up to one hour.
  • The numbers displayed as 'In use' are reset daily around 12:00 AM (midnight, Japan time).
  • The date and time are in Japan Standard Time.

Check the Web API usage status at 5-minute intervals.

  1. Specify the date you wish to check. Initially displayed is the current day’s data.
../../../_images/img_03.en204.png
[1] Number of API Requests
Displays the number of API requests that have been called.
[2] API Traffic Volume
Displays the traffic volume of APIs (in KB) that have been called.
[3] Requests exceeding short-term limit
Displays the number of requests exceeding the short-term (5-minute) limit.
[4] Requests exceeding daily limit
Displays the number of requests exceeding the daily limit.

Tip

  • Dates can be specified up to 60 days prior.
  • Dates and times are in Japan Standard Time.
  • Please refer to Usage restrictions of WebAPI for the limit.

Download the Web API access log

1.Click the 'Download' button for "API Access Log" to open the "Download API Access Log" view.

../../../_images/img_04.en175.png
  1. Specify the period for which you want to download the API access log, and click the 'Download' button.
../../../_images/img_05.en158.png

Tip

  • You can specify a period up to 60 days prior.
  • The date and time are in Japan Standard Time.

Hint

  • The format of the downloaded log file is as follows.
Field Description
api_op_date API execution date and time
company_id Company ID
api_name API name
api_type API type
request_size Request size (in bytes)
response_size Response size (in bytes)
response_code HTTP response status code
time_taken Time taken (in milliseconds)
ip_address Source IP address
  • The output values for api_type correspond to API types as follows.
Value Type of API
QueryRecords Specify search conditions for the table and get a list of search results
GetRecord Fetch one record of table data
InsertRecord Register one record of table data
UpdateRecord Update one record of table data
DeleteRecord Delete one record of table data
BulkInsertRecords Register table data in bulk
BulkUpdateRecords Update table data in bulk
BulkUpsertRecords Register or update table data in bulk
BulkDeleteRecords Delete table data in bulk
GetHeader Fetch the last modified date and time of the table (header information only)
GetRecords Fetch table data in bulk