API Logs allows users to check the status of API calls happening in the background of Ordway, as well as the history of actions taken. An API event is logged each time an API operation is invoked and for each API event. Gain valuable insights into API activities or debug your APIs through the logged data.
Logs are ideal for troubleshooting errors; what failed or completed, how, and when.
Notes:
- Logs are currently available for view only.
- Logs are maintained for 90 days.
- Logs display in UTC Time Zone.
Steps:
Navigate to Menu > Operations > Logs > API Logs.
API Statuses
The following statuses are available for API:
|
Status Code |
Name |
Description |
|
200 |
OK |
Indicates that the request has succeeded. |
|
400 |
Bad Request |
The request could not be understood by the server due to incorrect syntax. The client SHOULD NOT repeat the request without modifications. |
|
401 |
Unauthorized |
Indicates that the request requires user authentication information. |
|
403 |
Forbidden |
Your account is not authorized to access the requested resource. |
|
404 |
Not Found |
The server can not find the requested resource. |
|
422 |
Unprocessable Entity |
The request was well-formed but was unable to be followed due to semantic errors. |
|
500 |
Internal Server Error |
The server encountered an unexpected condition that prevented it from fulfilling the request. |
API Log Actions
View Log
To view a specific log, click either the Status link or click View from the Actions menu.
Sort API Logs
Click any column header to sort API Logs.
Filter API Logs
Use the available Filter options to locate a specific API log. Learn more about Filtering Data in Ordway.
Log Details
Each log provides detailed information regarding the request. The top portion of each log contains the following Summary information:
|
Field |
Description |
|
Request Method |
Request method used in the log entry. Options include: GET POST PUT DELETE |
|
Status |
Request status information. |
|
URL |
Endpoint of the API request. |
|
IP Address |
The IP Address used to execute the change. |
|
User |
The user who executed the action. |
|
Date |
Date/Time the log was executed. |
|
Processing Time |
Amount of time to execute the API call. |
Request body Parameters
A request body is data sent by the client to our API. The request body will include the object and corresponding properties depending on the request method used. A request body is not always required depending on the request method used.
Response Body
A response body is the data our API sends back to our clients. This section of the log details the response, including any error messages. Error messages are included when applicable.
Example:
Comments
0 comments
Please sign in to leave a comment.