Throughout This Page
You can jump to the specified sections by clicking on these titles.
Overview
The API Reports page provides the means to oversee connection endeavours undertaken by an individual API account. This functionality empowers you to create comprehensive reports encompassing several aspects: the tally of your call instances, the count of prosperous label applications, and the count of unsuccessful ones.
This guide will demonstrate the process of producing and comprehending a report within the API Reports page of the Shipping.
Generate Report
To initiate the creation of an API report, select "API Reports" from the menu on the left-hand side.
Subsequently, opt for the specific API account you intend to retrieve the report. Following this selection, click the "Generate Report" button.
This action will furnish you with a comprehensive overview of statistics about various categories of requests initiated through your designated API account.
Filters
The information presented on this page is initially based on a 7-day timeframe. Nevertheless, you can modify this scope by utilizing the filtering mechanism accessible through the "Show Filters" button.
Upon generating the report, it will exhibit the API Calls data within a predefined date range. Illustrated in the accompanying image, you'll notice a segment dedicated to the manual configuration of your desired date range.
Additionally, situated beneath this section is a feature allowing seamless navigation between different accounts. This feature streamlines the process of switching API accounts.
API Report
-
Endpoint URL: This denotes the destination in the Courier API where your request is directed. By inspecting the URL, you can extract valuable insights, such as the targeted courier and the purpose of the requests, which may involve tasks like label creation or label cancellation.
-
Call Count: This figure represents the aggregate count of label requests dispatched through the courier.
Successful Requests: This category showcases the count of requests executed successfully via the courier.
-
Failed Requests: Within this category, you can observe the tally of failed requests during transmission.