API Log Report
You can download the detail of your API request. The detailed information consists of date-time, access key, service analytics, job ID, status, message, and the result. Your download request will be sent to your registered email address. You can filter the API log by criteria.

Download API Log Report Through Dashboard

  • Login to dashboard.identifai.id
  • On the left navigation, click 'Statistik Penggunaan'
  • Click the Log API tab, then you will navigate to 'Log API'
Log API Download Page
  • Filter the log criteria that you would download.
Field
Description
Pilih Tanggal
Select the date range, the maximum date range that you can select are 3 months and the data is available for download is on the 2 years from the current date.
Time Zone
Select the time zone on the drop-down menu.
Analytic
Select the analytic. You can choose multiple analytics on the filter.
Access Key
Select the access key
  • The log API report can be downloaded through the link that is sent to your email as an Xls file. Please wait for 5-30 minutes until your log API is compiled by our system.
  • You will get an API log report that consists of columns are detailed below:
Information Detail
Description
Date Time
Detail timestamp of a response API
Access Key
Detail Access Key that used to do API request
Analytic
Detail service that requested
Job ID
Unique identifier that success requested the hit
Status
Status of API response
Message
Detail message of a response
Result
Detail analytics result of a response

Querying Report By API Request

We provide programmatic methods to access report data by using API requests. This method allows you to automate the collection report process, and build a custom dashboard in your own system.

Requesting the Report

Request Body

Send POST request to https://backend.cloud.nodeflux.io/analytic/logs with payload body below:
1
{
2
"start_date": "<start date range>",
3
"end_date": "<end date range>",
4
"analytic": "<your analytics>",
5
"time_zone": "<choose the timezone>",
6
"link_callback": "<your callback link>"
7
}
Copied!

Request Header

Key
Value
Authorization
{Your authorization key}
content-type
application/json
x-nodeflux-timestamp
{x-nodeflux-timestamp from your signature request}
Please check the Authorization Page to define your authorization and your x-nodeflux-timestamp.
Request example:
1
{
2
"start_date": "2020-06-21",
3
"end_date": "2020-12-12",
4
"analytic": "FACE_MATCH,OCR_KTP",
5
"time_zone": "Asia/Tokyo",
6
"link_callback": "https://callback.nodeflux.io/apilognotification/callback"
7
}
Copied!
Parameter
Details
Compulsory
start_date
a single date using YYYY-MM-DD format that telling the biginning of the range, it should be lower than end_date.
Required
end_date
a single date using YYYY-MM-DD format that telling the ending of the range, it should be greater than end_date.
Required
analytic
The API service that you use. The default setting will download all the analytics that contain hit usage.
Optional
time_zone
The specific time zone to define your time area. Please check on the time zone list to define the zone.
Optional
link_callback
To determine where the link download of the report will redirect after the download is success.
Required
  • The maximum date range that you can select are 3 months and the data is available for download is on the 2 years from the current date.

Output

The output of the report request is a link to download an .xls containing the log report.

Time Zone List

Time
Zone
GMT-12:00
Etc/GMT+12
GMT-11:00
Pacific/Midway
GMT-10:00
Pacific/Honolulu
GMT-09:00
US/Alaska
GMT-08:00
America/Los_Angeles
GMT-08:00
America/Tijuana
GMT-07:00
US/Arizona
GMT-07:00
America/Chihuahua
GMT-07:00
US/Mountain
GMT-06:00
America/Managua
GMT-06:00
US/Central
GMT-06:00
America/Mexico_City
GMT-06:00
Canada/Saskatchewan
GMT-05:00
America/Bogota
GMT-05:00
US/Eastern
GMT-05:00
US/East-Indiana
GMT-04:00
Canada/Atlantic
GMT-04:00
America/Caracas
GMT-04:00
America/Manaus
GMT-04:00
America/Santiago