get_query_stats
Retrieve detailed traffic statistics for top search queries from Bing Webmaster Tools to analyze website performance and optimize content strategy.
Instructions
Get detailed traffic statistics for top queries.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| site_url | Yes |
Implementation Reference
- mcp_server_bwt/main.py:203-218 (handler)The main handler function implementing the logic for the 'get_query_stats' tool. It fetches query statistics from the Bing Webmaster Tools API for a given site and processes the response.async def get_query_stats( site_url: Annotated[str, "The URL of the site"] ) -> List[Dict[str, Any]]: """ Get detailed traffic statistics for top queries. Args: site_url: The URL of the site Returns: List of query statistics with clicks, impressions, CTR, and position """ async with api: stats = await api._make_request(f"GetQueryStats?siteUrl={site_url}") return api._ensure_type_field(stats, "QueryStats")
- mcp_server_bwt/main.py:199-202 (registration)The @mcp.tool decorator that registers the 'get_query_stats' tool with the MCP server, providing the tool name and description.@mcp.tool( name="get_query_stats", description="Get detailed traffic statistics for top queries.", )
- mcp_server_bwt/main.py:59-111 (helper)Core helper method in BingWebmasterAPI class used by get_query_stats to make the actual API call to 'GetQueryStats' endpoint.async def _make_request( self, endpoint: str, method: str = "GET", json_data: Optional[Dict[str, Any]] = None, params: Optional[Dict[str, Any]] = None, ) -> Any: """Make a request to the Bing API and handle OData responses.""" if not self.client: raise RuntimeError( "API client not initialized. Use 'async with api:' context manager." ) headers = {"Content-Type": "application/json; charset=utf-8"} # Build URL with API key if "?" in endpoint: url = f"{self.base_url}/{endpoint}&apikey={self.api_key}" else: url = f"{self.base_url}/{endpoint}?apikey={self.api_key}" # Add additional parameters if provided if params: for key, value in params.items(): url += f"&{key}={value}" try: if method == "GET": response = await self.client.get(url, headers=headers) else: response = await self.client.request( method, url, headers=headers, json=json_data ) if response.status_code != 200: error_text = response.text logger.error(f"API error {response.status_code}: {error_text}") raise Exception(f"API error {response.status_code}: {error_text}") data = response.json() # Handle OData response format if "d" in data: return data["d"] return data except httpx.TimeoutException: logger.error(f"Request timeout for {endpoint}") raise Exception("Request timed out") except Exception as e: logger.error(f"Request failed: {str(e)}") raise
- mcp_server_bwt/main.py:112-120 (helper)Helper method called by the handler to add MCP-compatible __type fields to the API response data.def _ensure_type_field(self, data: Any, type_name: str) -> Any: """Ensure __type field is present for MCP compatibility.""" if isinstance(data, list): for item in data: if isinstance(item, dict) and "__type" not in item: item["__type"] = f"{type_name}:#Microsoft.Bing.Webmaster.Api" elif isinstance(data, dict) and "__type" not in data: data["__type"] = f"{type_name}:#Microsoft.Bing.Webmaster.Api" return data