Tool reference
Get site performance snapshot
Summarizes a site's overall Google + Bing search performance over a window and compares it with the immediately preceding window of the same length.
Tool name: get_site_snapshot
Cost: Free - not billed, and does not draw on a plan quota.
Read-only
This tool only reads. It never creates or changes anything, so an assistant may call it without asking you first.
Summarizes a site's overall Google + Bing search performance over a window and compares it with the immediately preceding window of the same length. Returns scalars only (totals, CTR, weighted average position, rank-bucket counts for one anchor date) - never the daily series; call get_performance_trend for that. total.avgPosition is always null (Bing's position scale against Google's is unverified, so a blended figure would not be a real number on either engine) and there is no cross-engine rank-bucket total (distinct-query counts are not additive across engines). No country or device breakdown is available for either engine - Bing exposes none on any traffic endpoint, and we do not ingest Google's. searchVertical does work, but Google-only: on image or video the bing and rankBuckets.bing blocks 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 - scheme, www., path and trailing slash are all stripped. Must resolve to a workspace the caller owns; call list_sites first if unsure 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. Resolved per engine by default to the latest date that engine has bucket data for - the two engines usually differ. |
searchVertical | "web" | "image" | "video" | No | Which Google search vertical to read: web (default), image, or video. Google-only - Bing Webmaster Tools does not split verticals on any traffic endpoint, so anything other than 'web' returns Google alone, with Bing excluded and declared in unsupportedInputs. A null or absent Bing figure then means 'not measurable', never 'zero'. Defaults to "web". |
Full input JSON Schema
{
"$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 - scheme, www., path and trailing slash are all stripped. Must resolve to a workspace the caller owns; call list_sites first if unsure 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. Resolved per engine by default to the latest date that engine has bucket data for - the two engines usually differ.",
"type": "string"
},
"searchVertical": {
"default": "web",
"description": "Which Google search vertical to read: web (default), image, or video. Google-only - Bing Webmaster Tools does not split verticals on any traffic endpoint, so anything other than 'web' returns Google alone, with Bing excluded and declared in `unsupportedInputs`. A null or absent Bing figure then means 'not measurable', never 'zero'.",
"type": "string",
"enum": ["web", "image", "video"]
}
},
"required": ["site"]
}Response
Full output JSON Schema
{
"$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
}