What is API usage tracking?
API usage tracking lets you monitor usage (in calls/requests) via Nearmap APIs by individual API applications. Your subscription will give you an allowance for the maximum number of API calls you can make per day.
The minimum Daily API Rate that you can purchase is 2000 requests/day.
Usage is measured by the API keys assigned to each application, recording the number of requests sent to the API. If your organization’s application is used by multiple clients, their API keys allow calls to be tracked and attributed to each specific client.
You can create the API key in MyAccount and name it in way that identifies the client using that key. This makes it easier for you to attribute costs to clients based on their usage.
You can view usage data in MyAccount and also download it as a CSV report.
Effective API usage tracking relies on how API keys are named/organized.
Viewing usage history
Select the duration for which you want to view API usage history. The heat map is updated to show a breakdown of the daily usage. Hover over a square to see the usage details for the day. Also see, View Your Account Data Usage.
Viewing API usage data
You can view usage data for WMS and Tile API by application name.
To do so, navigate to Account, Usage. Scroll to the panel below Usage History and select the By API App tab.
This tab displays data based on the duration you selected for the Usage History chart (last 12 months, current term or selected month):
- API application name
- Number of API keys created to access the application
- Usage (number of API calls made)
- Tile Count
- Status - whether the application is active or has been deactivated
You can also view usage by user and the number of API calls they have made in the given period.
Searching
To search usage for a specific API application, click Search, and type a part of or the entire name of the application you want to locate.
Downloading
The Download icon (next to the Search icon) will export the data for the selected duration into a .csv file. The following information is displayed in the downloaded CSV:
api app name - Name of the application. The API app name will appear as blank when the usage originates from MapBrowser. If usage is associated with an application that shows a blank API App Name, it likely means that the API key assigned to that application has been deleted. isactive - Whether the application is still in use indicated by TRUE.isdeleted - Whether the application has been deleted indicated by TRUE, and FALSE if the application is in use. email - Email address of the user associated with the application.client_type - Indicates whether the usage is attributed to an API application or to MapBrowser.tile_count - The number of tiles in the AOI returned by the API. 2d_data (bytes) - Nearmap 2D data consumed by the client_type.
The downloaded file provides additional data to facilitate comparison between data usage via MapBrowser and via applications. You can filter the data in the CSV file by the client_type property to filter data consumption by application or by MapBrowser.