What is project-based usage tracking?
Project-based usage tracking allows you view data usage via MapBrowser, WMS and Tile API by individual API applications. This data usage is tracked through the API keys associated with an application. When your organization has multiple clients using an application, data usage can be attributed to a particular client based on their API key. 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 project tracking relies on how API keys are named/organized.
Viewing API 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 project-based usage
You can view usage data for WMS and Tile API by application name. Note that the data shown here is only for API applications; it does not include usage via MapBrowser.
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 (Data)
- Tile Count
- Status - whether the application is active or has been deactivated
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 usage
You can download usage for all users, content types or applications for this subscription.
The Download icon (next to the Search icon) will export the data for the selected period to a .CSV file, showing data for the selected usage type. For more information, see MyAccount Interface.
The following information is displayed:
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 or viewed via MapBrowser.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.
This per user data does not contain any ArcGIS Online usage.
Browser support for CSV download
- Google Chrome
- Mozilla Firefox
On Safari, users will get a new tab with the data rather than a download.