Get site performance snapshot
The tool summarizes a site's Google and Bing search performance for a window, and compares it with the window of the same length just before it. It returns totals only. Call get_performance_trend for the daily series. The totals include clicks, impressions, click-through rate, a weighted average position, and rank-bucket counts for one date. total.avgPosition is always null. Bing's position scale is not confirmed to match Google's, so a blended position would not be a real number on either engine. There is no combined rank-bucket total, because a query counted on both engines is not one query. Neither engine can split these totals by country or by device. Bing exposes no such split on any traffic report, and Google's split is not stored here. If you ask for image or video search, the Bing block and rankBuckets.bing are absent, and total is Google's figure alone.
get_site_snapshotThe tool summarizes a site's Google and Bing search performance for a window, and compares it with the window of the same length just before it.
It returns totals only. Call get_performance_trend for the daily series. The totals include clicks, impressions, click-through rate, a weighted average position, and rank-bucket counts for one date.
total.avgPosition is always null. Bing's position scale is not confirmed to match Google's, so a blended position would not be a real number on either engine. There is no combined rank-bucket total, because a query counted on both engines is not one query.
Neither engine can split these totals by country or by device. Bing exposes no such split on any traffic report, and Google's split is not stored here.
If you ask for image or video search, the Bing block and rankBuckets.bing are absent, and total is Google's figure alone.
Parameters
| Parameter | Type | Required | Notes |
|---|---|---|---|
site | string | Yes | The site to look up, as a bare domain ("example.com") or a URL. The tool strips the scheme, www, path, and trailing slash. The site must belong to a workspace you own. Call list_sites first if you are not sure of the exact domain. |
windowDays | integer | No | Length of the current (and comparison) window, in days. Defaults to 28. |
to | string | No | Last day of the current window (YYYY-MM-DD). Defaults to the most recent date either engine has data for. |
rankBucketsDate | string | No | Anchor date (YYYY-MM-DD) for the rank-bucket snapshot. If you omit it, each engine uses the latest date it has bucket data for. Those two dates usually differ. |
searchVertical | "web" | "image" | "video" | No | Which Google search type to read: web (the default), image, or video. Bing Webmaster Tools does not split search types on any traffic report, so image and video return Google only. The response records that Bing was left out, in unsupportedInputs. A missing Bing number then means Bing was not measured. Defaults to "web". |
Full input JSON SchemaTypes, defaults and validation rules
json
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "site": { "type": "string", "minLength": 1, "description": "The site to look up, as a bare domain (\"example.com\") or a URL. The tool strips the scheme, www, path, and trailing slash. The site must belong to a workspace you own. Call list_sites first if you are not sure of the exact domain." }, "windowDays": { "default": 28, "description": "Length of the current (and comparison) window, in days.", "type": "integer", "exclusiveMinimum": 0, "maximum": 365 }, "to": { "description": "Last day of the current window (YYYY-MM-DD). Defaults to the most recent date either engine has data for.", "type": "string" }, "rankBucketsDate": { "description": "Anchor date (YYYY-MM-DD) for the rank-bucket snapshot. If you omit it, each engine uses the latest date it has bucket data for. Those two dates usually differ.", "type": "string" }, "searchVertical": { "default": "web", "description": "Which Google search type to read: web (the default), image, or video. Bing Webmaster Tools does not split search types on any traffic report, so image and video return Google only. The response records that Bing was left out, in unsupportedInputs. A missing Bing number then means Bing was not measured.", "type": "string", "enum": [ "web", "image", "video" ] } }, "required": [ "site" ]}Response
Full output JSON SchemaEvery field the response can contain
json
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "site": { "type": "string" }, "workspaceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "searchVertical": { "type": "string", "enum": [ "web", "image", "video" ] }, "currentWindow": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false }, "comparisonWindow": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" } }, "required": [ "start", "end" ], "additionalProperties": false }, "google": { "type": "object", "properties": { "current": { "type": "object", "properties": { "attached": { "type": "boolean" }, "totalClicks": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalImpressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ctr": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avgPosition": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "positionCoverageImpressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avgClicksPerDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avgImpressionsPerDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "measuredDays": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "windowDays": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "attached", "totalClicks", "totalImpressions", "ctr", "avgPosition", "positionCoverageImpressions", "avgClicksPerDay", "avgImpressionsPerDay", "measuredDays", "windowDays" ], "additionalProperties": {} }, "comparison": { "type": "object", "properties": { "attached": { "type": "boolean" }, "totalClicks": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalImpressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ctr": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avgPosition": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "positionCoverageImpressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avgClicksPerDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avgImpressionsPerDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "measuredDays": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "windowDays": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "attached", "totalClicks", "totalImpressions", "ctr", "avgPosition", "positionCoverageImpressions", "avgClicksPerDay", "avgImpressionsPerDay", "measuredDays", "windowDays" ], "additionalProperties": {} }, "delta": { "type": "object", "properties": { "totalClicks": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalImpressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ctr": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avgPosition": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "totalClicks", "totalImpressions", "ctr", "avgPosition" ], "additionalProperties": {} } }, "required": [ "current", "comparison", "delta" ], "additionalProperties": false }, "bing": { "type": "object", "properties": { "current": { "type": "object", "properties": { "attached": { "type": "boolean" }, "totalClicks": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalImpressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ctr": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avgPosition": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "positionCoverageImpressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avgClicksPerDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avgImpressionsPerDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "measuredDays": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "windowDays": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "attached", "totalClicks", "totalImpressions", "ctr", "avgPosition", "positionCoverageImpressions", "avgClicksPerDay", "avgImpressionsPerDay", "measuredDays", "windowDays" ], "additionalProperties": {} }, "comparison": { "type": "object", "properties": { "attached": { "type": "boolean" }, "totalClicks": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalImpressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ctr": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avgPosition": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "positionCoverageImpressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avgClicksPerDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avgImpressionsPerDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "measuredDays": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "windowDays": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "attached", "totalClicks", "totalImpressions", "ctr", "avgPosition", "positionCoverageImpressions", "avgClicksPerDay", "avgImpressionsPerDay", "measuredDays", "windowDays" ], "additionalProperties": {} }, "delta": { "type": "object", "properties": { "totalClicks": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalImpressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ctr": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avgPosition": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "totalClicks", "totalImpressions", "ctr", "avgPosition" ], "additionalProperties": {} } }, "required": [ "current", "comparison", "delta" ], "additionalProperties": false }, "total": { "type": "object", "properties": { "current": { "type": "object", "properties": { "attached": { "type": "boolean" }, "totalClicks": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalImpressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ctr": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avgPosition": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "positionCoverageImpressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avgClicksPerDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avgImpressionsPerDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "measuredDays": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "windowDays": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "attached", "totalClicks", "totalImpressions", "ctr", "avgPosition", "positionCoverageImpressions", "avgClicksPerDay", "avgImpressionsPerDay", "measuredDays", "windowDays" ], "additionalProperties": {} }, "comparison": { "type": "object", "properties": { "attached": { "type": "boolean" }, "totalClicks": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalImpressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ctr": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avgPosition": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "positionCoverageImpressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avgClicksPerDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avgImpressionsPerDay": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "measuredDays": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "windowDays": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "attached", "totalClicks", "totalImpressions", "ctr", "avgPosition", "positionCoverageImpressions", "avgClicksPerDay", "avgImpressionsPerDay", "measuredDays", "windowDays" ], "additionalProperties": {} }, "delta": { "type": "object", "properties": { "totalClicks": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "totalImpressions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ctr": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avgPosition": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "totalClicks", "totalImpressions", "ctr", "avgPosition" ], "additionalProperties": {} }, "coverage": { "type": "object", "properties": { "googleMeasuredDays": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "bingMeasuredDays": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "googleFirstMeasured": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "googleLastMeasured": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bingFirstMeasured": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bingLastMeasured": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "alignedDays": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "googleMeasuredDays", "bingMeasuredDays", "alignedDays" ], "additionalProperties": {} } }, "required": [ "current", "comparison", "delta", "coverage" ], "additionalProperties": false }, "rankBuckets": { "type": "object", "properties": { "google": { "type": "object", "properties": { "asOf": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "current": { "type": "object", "properties": { "pos13": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "pos410": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "pos1120": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "pos21Plus": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "additionalProperties": {} }, "comparison": { "type": "object", "properties": { "pos13": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "pos410": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "pos1120": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "pos21Plus": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "additionalProperties": {} }, "noImpressions": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "current", "comparison" ], "additionalProperties": {} }, "bing": { "type": "object", "properties": { "asOf": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "current": { "type": "object", "properties": { "pos13": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "pos410": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "pos1120": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "pos21Plus": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "additionalProperties": {} }, "comparison": { "type": "object", "properties": { "pos13": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "pos410": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "pos1120": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "pos21Plus": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "additionalProperties": {} }, "noImpressions": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "current", "comparison" ], "additionalProperties": {} } }, "required": [ "google", "bing" ], "additionalProperties": false }, "unsupportedInputs": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "engine": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reason": { "type": "string" } }, "required": [ "field", "reason" ], "additionalProperties": {} } }, "lastSyncedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "site", "workspaceId", "searchVertical", "currentWindow", "comparisonWindow", "google", "bing", "total", "rankBuckets", "unsupportedInputs" ], "additionalProperties": false}