Viewing Bing Maps Usage Reports
Requests sent to Bing Maps APIs with a valid Bing Maps Key are logged for reporting purposes. The following are examples of transactions that are logged when you use a Bing Maps Key:
-
Opening a browser session using the Bing Maps AJAX Control 6.3 or the Bing Maps Silverlight Control.
-
Launching an application that uses the Bing Maps Silverlight Control for Windows Phone.
-
Using the Bing Maps REST Services Routes API to calculate a route between two locations.
-
Using the Bing Maps SOAP Services Geocode method to geocode an address.
-
Using the Bing Spatial Data Services Geocode Dataflow API to geocode a set of addresses.
-
Using the Bing Spatial Data Services LoadDataSource Dataflow API or the Bing Maps Account Center to create or update a data source.
Usage reports provide a summary of your transactions over time. You can view usage reports for a Bing Maps Key and its associated application on the Bing Maps Account Center. It may take up to 24 hours for new transactions to appear in your usage reports.
You can also view token usage reports for the MapPoint Web Service on the Bing Maps Account Center. For a list of token usage categories, see Viewing Bing Maps Token Transaction Reports. To view token usage reports for other APIs, such as Bing Maps AJAX Control 6.3 or Bing Maps SOAP Services, use the Bing Maps Platform Customer Services site.
Benefits of usage reporting include the ability to:
-
Monitor reported usage during a given time period.
-
Reconcile reported usage with enterprise billing invoices.
-
Estimate expected usage prior to an application “going live”.
Instructions for how to view usage reports are provided at the end of this topic.
Bing Maps Key Usage Categories
When you use a Bing Maps Key with the Bing Maps AJAX Control 6.3, Bing Maps Silverlight Control, Bing Maps SOAP Services, Bing Maps REST Services, or Bing Spatial Data Services, transactions are recorded. These transactions are grouped into billable and non-billable usage categories.
Billable versus non-billable transactions
A billable transaction is a transaction that would be charged under an enterprise license agreement. Non-billable transactions are not charged under an enterprise license agreement. However, non-billable transactions are still recorded to provide you with information about how your application is used.
The following tables describe the reporting usage categories and specifies whether the categories are billable or non-billable.
Map Controls
| Category | Bing Maps API | Billable | Category Description |
|---|---|---|---|
|
AjaxSession |
AJAX Control |
Yes |
Any time a session that uses the Bing Maps AJAX Control 6.3, Version 6.3 or Version 7.0, is started with a valid Bing Maps Key, one transaction is counted. A session begins with the load of the Bing Maps AJAX Control into a user’s browser and includes all Bing Maps AJAX Control interactions until the browser is closed or the user moves to a different page. This includes all SOAP, REST or Spatial Data service requests that occur within the session. |
|
SilverlightSession |
Silverlight Control |
Yes |
Any time a session that uses the Bing Maps Silverlight Control is started with a valid Bing Maps Key, one transaction is counted. A session begins with the load of the Bing Maps Silverlight Control into a user’s browser and includes all Bing Maps Silverlight Control interactions until the browser is closed or the user moves to a different page. This includes all SOAP, REST or Spatial Data service requests that occur within the session. |
|
WPFSession |
WPF Control |
Yes |
Any time an application session is started and uses the Bing Maps WPF Control with a valid Bing Maps Key, one transaction is counted. An application session begins with the load of the Bing Maps WPF Control by the application and includes all Bing Maps WPF Control interactions until the application is closed. This includes all SOAP, REST or Spatial Data service requests that occur within the application. |
|
WindowsPhoneSession_PublicApp |
Silverlight Control for Windows Phone |
No |
Any time a session begins with the launch of an application that uses the Bing Maps Silverlight Control for Windows Phone, one transaction is counted. This includes all map control interactions that occur until the application is closed. |
REST Services
| Category | Bing Maps API | Billable | Category Description |
|---|---|---|---|
|
RESTLocations |
REST Services |
Yes* |
Any time a Locations API URL request is made to geocode or reverse-geocode location data, one transaction is counted. |
|
RESTImagery |
REST Services |
Yes* |
Any time an Imagery API URL request is made to get a static map, to get static map metadata or to get imagery metadata that contains a map tile URI, one transaction is counted. |
|
RESTImagery-BasicMetadata |
REST Services |
No |
Any time an Imagery API URL request is made to get basic imagery metadata that does not contain a map tile URI, one transaction is counted. |
|
RESTRoutes |
REST Services |
Yes* |
Any time a Routes API URL request is made to find a route, one transaction is counted. |
|
RESTTraffic |
REST Services |
Yes* |
Any time a Traffic API URL request is made to get traffic incident information, one transaction is counted. |
*This category is not billable if it occurs within the context of an AJAX Control or Silverlight Control session.
Spatial Data Services
| Category | Bing Maps API | Billable | Category Description |
|---|---|---|---|
|
Dataflow:Create |
Spatial Data Services |
No |
Any time a URL request is made to Upload Spatial Data and Create a Geocode Job, one transaction is counted. Any time a URL request is made to Create a Load Data Source Job and Input Entity Data, one transaction is counted. Any time a data source is created or updated using the Bing Maps Account Center. |
|
Dataflow:Get |
Spatial Data Services |
No |
Any time a URL request is made to Get Status of a Geocode Job, one transaction is counted. Any time a URL request is made to Get Status of a Load Data Source Job, one transaction is counted. Any time a URL request is made to Get Download Status, one transaction is counted. Any time a data source is created or updated using the Bing Maps Account Center. |
|
Dataflow:Download |
Spatial Data Services |
No |
Any time a URL request is made to Download Geocode Job Results, one transaction is counted. Note that the URL used to download the successful results and the URL used to download failed results each count as a separate Dataflow:Download transaction. |
|
RESTSpatialDataService:GetAllMetadata |
Spatial Data Services |
No |
Any time a URL request is made to Get Data Source Information that returns metadata for all data sources that are associated with a Bing Maps Account, one transaction is counted. |
|
RESTSpatialDataService:GetDataSource |
Spatial Data Services |
No |
Any time a URL request is made to Get Data Source Information that returns general information about a single data source, one transaction is counted. |
|
RESTSpatialDataService:GetDataSourceMetadata |
Spatial Data Services |
No |
Any time a URL request is made to Get Data Source Information that returns metadata for a single data source, one transaction is counted. |
|
RESTSpatialDataService:ListDataSources |
Spatial Data Services |
No |
Any time a URL request is made to Get Data Source Information that returns general information about all data sources associated with a Bing Maps Account, one transaction is counted. |
|
RESTSpatialDataService:DownloadDatasource |
Spatial Data Services |
No |
Any time a URL request is made to Create a Download Job, one transaction is counted. Any time a URL request is made to Get Downloaded Data, one transaction is counted. Any time a data source is downloaded using the Bing Maps Account Center. |
|
RESTSpatialDataService:DeleteDataSource |
Spatial Data Services |
No |
Any time a URL request is made to Delete a Data Source, one transaction is counted. Any time a data source is deleted using the Bing Maps Account Center. |
|
RESTSpatialDataService:Query |
Spatial Data Services |
Yes* |
Any time a Query API URL request is made to query a data source, one transaction is counted. |
*This category is not billable if it occurs within the context of an AJAX Control or Silverlight Control session.
SOAP Services
| Category | Bing Maps API | Billable | Category Description |
|---|---|---|---|
|
WS: Geocode |
SOAP Services |
Yes* |
Any time a request is made using the GeocodeServiceClient.Geocode Method method, one transaction is counted. |
|
WS: ReverseGeocode |
SOAP Services |
Yes* |
Any time a request is made using the GeocodeServiceClient.ReverseGeocode Method , one transaction is counted. |
|
WS: Get ImageryMetadata |
SOAP Services |
No |
Any time a request is made using the ImageryServiceClient.GetImageryMetadata Method, one transaction is counted. |
|
WS: GetMapUri |
SOAP Services |
Yes* |
Any time a request is made using the ImageryServiceClient.GetMapUri Method, one transaction is counted. |
|
WS: CalculateRoute |
SOAP Services |
Yes* |
Any time a request is made using the RouteServiceClient.CalculateRoute Method, one transaction is counted. |
|
WS: CalculateRoutesFromMajorRoads |
SOAP Services |
Yes* |
Any time a request is made using the RouteServiceClient.CalculateRoutesFromMajorRoads Method and the MajorRoutesOptions.ReturnRoutes Property is set to false, one transacation is counted. Anytime a request is made using the RouteServiceClient.CalculateRoutesFromMajorRoads Method and the MajorRoutesOptions.ReturnRoutes Property is set to true, one transaction for the request and additional transactions for each returned route are counted. |
|
WS: Search |
SOAP Services |
Yes* |
Any time a request is made using the SearchServiceClient.Search Method, one transaction is counted. |
|
WS: PhotoSynthView |
SOAP Services |
Yes |
Any time a Synth associated with a Windows Live ID that corresponds to an enterprise Photosynth account is viewed, one transaction is counted. Every Synth is associated with a Windows Live ID. |
*This category is not billable if it occurs within the context of an AJAX Control or Silverlight Control session.
Viewing Usage Reports
Follow these steps to view usage reports for a Bing Maps Key and its associated applications.
-
Log in to http://www.bingmapsportal.com using the Windows Live ID you used to create your Bing Maps Account.
-
Click the View my Bing Maps API usage menu in the navigation bar on the left.
-
Click Usage Report to view a timeline that summarizes billable and non-billable Bing Maps Key usage.
Click Usage Report by Category to get Bing Maps Key usage details by category.
Click Usage Report by Bing Maps Key to get Bing Maps API usage for a specified Bing Maps Key.
Click Legacy (MWS + Token) Usage Report or Legacy (MWS + Token) Usage Report by Category to view token usage for the MapPoint Web Service.
Usage reports open in a separate window.
Additional Notes
To change the range of dates for the report, set the Start Date and End Date fields, and then click View Report.
To export the data in the report, select a format in the drop-down list, and then click Export.
