You may want to reconcile, analyze, or debug API requests in the Test or Live environment.
Using API logs, you can see information about your API requests, such as the requests, responses, and metadata of your API requests.
Use Case
- Checking if you have made API request to Xendit or not (especially useful during integration period in Test mode);
- Checking the API key name and IP address of a specific API request;
- Checking the response time of a particular API request;
Limitation
-
You need to activate API Log in order to be able to use this feature;
- Reach us out to activate API Log for your Dashboard!
-
You need to have a Developer user permission on dashboard in order to access API Logs;
- This means, OWNED sub account would not have API Logs in its dashboard;
-
See more regarding dashboard user permissions here.
-
API Log will be available upon successful API authentication.
- API requests that has authentication errors, like INVALID_API_KEY error will not be displayed to API Logs
- Xendit only retains your API logs for 90 days;
- API logs cover all Xendit APIs, except for requests made from our Third Party Integrations (such as Shopify, WooCommerce, etc).
-
Response time displayed in API Logs refers to the duration to process your API request within Xendit's system.
- It does not include the time for the request to travel from your server to Xendit's server
Steps
- Open API Logs page, under “Developer” tab;
- You will see logs of all of your API traffic;
-
In order to search for a particular API Request, there are two ways that you can choose to do:
-
Via Request ID
-
Find this unique identifier in the response headers, under Request-ID.
-
If you need to contact us about a specific API request, providing the Request ID would help us find the particular API request faster, thus ensuring the fastest possible resolution;
-
If you need to contact us about a specific API request, providing the Request ID would help us find the particular API request faster, thus ensuring the fastest possible resolution;
-
Paste the Request-ID in the search bar to find logs in API Logs in Dashboard;
-
Find this unique identifier in the response headers, under Request-ID.
-
Via Filter Adjustment
- Adjust the date time filter, based on the timestamp of your API Request;
- Adjust the method filter, based on the method of your API Request (PUT, DELETE, POST, PATCH, or GET);
- Adjust the status code filter, based on the HTTP status code of your API Request;
-
Adjust the API Endpoint filter, based on the endpoint of your API Request;
-
Via Request ID
For further information, you can read more here.