Bing Webmaster Tools is a free service from Microsoft that helps website owners monitor how their sites appear in Bing search results. It reports the search queries for which a site appears, and the impressions and clicks that each query and page receives.
Hevo uses the Bing Webmaster API to replicate the verified sites of your Bing Webmaster Tools account and their query, page, and keyword statistics to the Destination of your choice. To ingest data, you must provide Hevo with the API key of your Bing Webmaster Tools account.
Supported Features
| Feature Name | Supported |
|---|---|
| Capture deletes | Yes |
| History mode | No |
| Custom data (user-configured tables & fields) | No |
| Data blocking (skip objects and fields) | Yes |
| Resync (objects and Pipelines) | Yes |
| API configurable | Yes |
Prerequisites
-
An active Bing Webmaster Tools account with at least one verified site.
-
An API key of your Bing Webmaster Tools account. Read Generate an API Key.
Generate an API Key
Hevo connects to your Bing Webmaster Tools account using an API key. The key belongs to your user and not to a site, so Hevo ingests the data of all the sites that are verified in your account. Bing Webmaster Tools allows only one API key for each user.
Perform the following steps to generate an API key:
-
Log in to your Bing Webmaster Tools account.
-
Click the Settings icon in the top-right corner of the page, and then click API Access.
-
If you are using API access for the first time, read and accept the terms and conditions.
-
Click API Key, and then click Generate API Key.
-
Copy the API key and save it securely like any other password.
Read Getting Access to the Bing Webmaster Tools API for more information.
If you delete the API key in Bing Webmaster Tools, Hevo cannot connect to your account, and the Pipeline fails. To resume data ingestion, generate a new API key and modify the Source configuration with it.
Configure Bing Webmaster Tools as a Source in your Pipeline
Perform the following steps to configure your Bing Webmaster Tools Source:
-
Click Pipelines in the Navigation Bar.
-
Click + Create Pipeline in the Pipelines List View.
-
On the Select Source Type page, select Bing Webmaster Tools.
-
On the Select Destination Type page, select the type of Destination you want to use.
-
On the Configure Source page, specify the following:
-
Source Name: A unique name for your Source, not exceeding 255 characters. For example, Bing Webmaster Tools Source.
-
In the Connect to Bing Webmaster Tools section:
- API Key: The API key that you generated in your Bing Webmaster Tools account.
-
-
Click Test & Continue to test the connection to your Bing Webmaster Tools Source. Once the test is successful, you can proceed to set up your Destination.
Data Replication
Hevo replicates data for all the objects selected on the Configure Objects page during Pipeline creation. By default, all supported objects and their available fields are selected. However, you can modify this selection while creating or editing the Pipeline. To ingest a child object, you must also select its parent object, User Sites.
Hevo ingests the entire data of all the selected objects in each run, as per the sync frequency. For each verified site, Hevo ingests the statistics that Bing Webmaster Tools provides for the site, and Bing updates these statistics once a week.
You can resync the User Sites object. Resyncing it also resyncs its child objects.
Note: You can create a Pipeline with this Source only using the Merge load mode. The Append mode is not supported for this Source.
Schema and Primary Keys
Hevo uses the following schema to upload the records in the Destination. For a detailed view of the objects, fields, and relationships, click the ERD.
Data Model
The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:
| Object | Description |
|---|---|
| Keyword Statistics | Contains the impressions in Bing search, in the United States and in English, for each top search query of your sites, by date. |
| Page Query Statistics | Contains the search queries for which each top page of your sites appeared, with the impressions, clicks, and average positions of each query, by date. |
| Page Statistics | Contains the top pages of each site in Bing search, with the impressions, clicks, and average impression and click positions of each page, by date. It includes a child object, Page Query Statistics. |
| Query Page Statistics | Contains the pages that appeared in Bing search for each top search query of your sites, with the impressions, clicks, and average positions of each page, by date. |
| Query Statistics | Contains the top search queries for which each site appeared in Bing search, with the impressions, clicks, and average impression and click positions of each query, by date. It includes the child objects, Keyword Statistics and Query Page Statistics. |
| User Sites | Contains the sites added to your Bing Webmaster Tools account, including the URL, verification status, and verification codes of each site. It includes the child objects, Page Statistics and Query Statistics. |
Additional Information
Read the detailed Hevo documentation for the following related topics:
Handling of Deletes
Hevo captures the deletes of the User Sites object by comparing the data ingested from the Source with the data present in the Destination in each run. If you remove a site from your Bing Webmaster Tools account, Hevo marks it as deleted by setting the value of the metadata column __hevo__marked_deleted to True. The record remains in the Destination with all its data.
Hevo does not capture deletes for the statistics objects. The statistics records remain in the Destination, even if Bing Webmaster Tools no longer returns them.
Source Considerations
-
The statistics objects contain data only for the sites that are verified in Bing Webmaster Tools and that receive impressions in Bing search. For a new or low-traffic site, these objects may be empty.
-
Hevo ingests the keyword statistics of the United States market in English. The statistics of other countries and languages are not ingested.