Generate search performance report
The tool builds a Google and Bing performance report for one site or several. It calls the other tools and embeds each response whole. A section here is the same answer that tool gives on its own, including unsupportedInputs. sites is a comma-separated list, capped at 10. The sites are read one after another, so a wide report is a slow call. Sections default to summary, trend, and topMovers. The other four are opportunities, siteSections, brandSplit, and crossEngine. Each of those costs at least one more stored scan per site, so ask for them only when the report is about them. A partial result is labelled. A site you cannot reach comes back with status set to error. A section that failed comes back with status set to failed, inside that site's sections. Report those. portfolio is a cross-site total of clicks and impressions only. It is null unless every counted site used the same window. Pass to if you want that total.
generate_search_performance_reportThe tool builds a Google and Bing performance report for one site or several.
It calls the other tools and embeds each response whole. A section here is the same answer that tool gives on its own, including unsupportedInputs.
sites is a comma-separated list, capped at 10. The sites are read one after another, so a wide report is a slow call. Sections default to summary, trend, and topMovers. The other four are opportunities, siteSections, brandSplit, and crossEngine. Each of those costs at least one more stored scan per site, so ask for them only when the report is about them.
A partial result is labelled. A site you cannot reach comes back with status set to error. A section that failed comes back with status set to failed, inside that site's sections. Report those. portfolio is a cross-site total of clicks and impressions only. It is null unless every counted site used the same window. Pass to if you want that total.
Parameters
| Parameter | Type | Required | Notes |
|---|---|---|---|
sites | string | Yes | Comma-separated sites (bare domains or URLs), at most 10. Each must resolve to a workspace you own; call list_sites if unsure of the exact domains. |
sections | string | No | Comma-separated sections: summary, trend, topMovers, opportunities, siteSections, brandSplit, crossEngine. Defaults to "summary,trend,topMovers". |
windowDays | integer | No | Length of the current window, in days. Defaults to 28. |
to | string | No | Last day of the window (YYYY-MM-DD), applied to every site. If you omit it, each site uses its own latest measured day. The standalone tools do the same, but the sites then sit on different windows and portfolio stays null. |
trendGranularity | "daily" | "weekly" | "monthly" | No | Bucket size for the trend section. Weekly by default: a daily series per site makes a multi-site report very large for no extra signal at report altitude. Defaults to "weekly". |
rowLimit | integer | No | Rows per table-shaped section, per site. Defaults to 10. |
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
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "sites": { "type": "string", "minLength": 1, "description": "Comma-separated sites (bare domains or URLs), at most 10. Each must resolve to a workspace you own; call list_sites if unsure of the exact domains." }, "sections": { "default": "summary,trend,topMovers", "description": "Comma-separated sections: summary, trend, topMovers, opportunities, siteSections, brandSplit, crossEngine.", "type": "string" }, "windowDays": { "default": 28, "description": "Length of the current window, in days.", "type": "integer", "exclusiveMinimum": 0, "maximum": 365 }, "to": { "description": "Last day of the window (YYYY-MM-DD), applied to every site. If you omit it, each site uses its own latest measured day. The standalone tools do the same, but the sites then sit on different windows and portfolio stays null.", "type": "string" }, "trendGranularity": { "default": "weekly", "description": "Bucket size for the trend section. Weekly by default: a daily series per site makes a multi-site report very large for no extra signal at report altitude.", "type": "string", "enum": [ "daily", "weekly", "monthly" ] }, "rowLimit": { "default": 10, "description": "Rows per table-shaped section, per site.", "type": "integer", "exclusiveMinimum": 0, "maximum": 100 }, "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": [ "sites" ]}Response
Full output JSON SchemaEvery field the response can contain
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "requestedSites": { "type": "array", "items": { "type": "string" } }, "sections": { "type": "array", "items": { "type": "string" } }, "searchVertical": { "type": "string", "enum": [ "web", "image", "video" ] }, "windowDays": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "dateTo": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "siteReports": { "type": "array", "items": { "type": "object", "properties": { "site": { "type": "string" }, "workspaceId": { "anyOf": [ { "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)$" }, { "type": "null" } ] }, "status": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "searchVertical": { "type": "string", "enum": [ "web", "image", "video" ] }, "summary": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": {} }, { "type": "null" } ] }, "trend": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": {} }, { "type": "null" } ] }, "topMovers": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": {} }, { "type": "null" } ] }, "opportunities": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": {} }, { "type": "null" } ] }, "siteSections": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": {} }, { "type": "null" } ] }, "brandSplit": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": {} }, { "type": "null" } ] }, "crossEngine": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": {} }, { "type": "null" } ] }, "sections": { "type": "array", "items": { "type": "object", "properties": { "section": { "type": "string" }, "status": { "type": "string" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "section", "status" ], "additionalProperties": {} } } }, "required": [ "site", "workspaceId", "status", "searchVertical", "sections" ], "additionalProperties": {} } }, "portfolio": { "anyOf": [ { "type": "object", "properties": { "sitesCounted": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "window": { "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 }, "totalClicks": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "totalImpressions": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "ctr": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "previousTotalClicks": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "previousTotalImpressions": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deltaClicks": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deltaImpressions": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "sitesCounted", "window", "comparisonWindow", "totalClicks", "totalImpressions", "ctr", "previousTotalClicks", "previousTotalImpressions", "deltaClicks", "deltaImpressions" ], "additionalProperties": {} }, { "type": "null" } ] }, "unsupportedInputs": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "engine": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reason": { "type": "string" } }, "required": [ "field", "reason" ], "additionalProperties": {} } } }, "required": [ "requestedSites", "sections", "searchVertical", "windowDays", "siteReports", "portfolio", "unsupportedInputs" ], "additionalProperties": false}