API Logs Report
The API Logs allow you to view the logs of the API, including information such as request ID, response code, URL, Amazon ID, IP address, and method. It will allow users to see how the API is performing and which APIs are generating which types of errors, allowing them to improve the API.
To view the API logs, click on the Reporting > API Logs tab on the side-navigation.
You can also filter the report based on the fields listed below:
-
Enter or select the field.
-
Click Search.
| Field | Description |
|---|---|
| Request Id | Unique Identifier of API request. |
| Response Code | Response of the API. 100: The client should continue the request or ignore the response if the request is already finished. 200: The request succeeded. 300: The request has more than one possible response. 400: The server could not understand the request due to invalid syntax. 500: The server has encountered a situation it does not know how to handle. 502: This error response means that the server, while working as a gateway to get a response needed to handle the request, got an invalid response. |
| URL | URL of API. |
| Total Response Time(ms) | Total time taken to respond to the request: |
| Amazon ID | AWS gateway request id to check logs. |
| Method | Type of request: Get: To Read Post: To Create Put: To Update/replace Patch: To Update Delete: To Delete |
| IP Address | IP address of device from where the request has been generated. |
| Date-Time | Date and time of instance when request came to the servers. |
| Operator | Filter with respect to total response time by the below operator: Equal = : Equal to total response time. Greater than > : Greater than to total response time. Greater than Equal To >= : Greater than equal to total response time. Less Than < : Less than to total response time. Less Than Equal to <= : Less than equal to total response time. |
Updated 11 months ago