Get site performance trend

The tool returns a site's Google and Bing performance as a daily, weekly, or monthly series. Weekly and monthly points roll up the daily series. Clicks and impressions are summed. Position is weighted by impressions. The series is for the whole site. Filtering by one page or one query is not supported. Leave from and to empty to get the full history that is stored.

get_performance_trend

The tool returns a site's Google and Bing performance as a daily, weekly, or monthly series.

Weekly and monthly points roll up the daily series. Clicks and impressions are summed. Position is weighted by impressions. The series is for the whole site. Filtering by one page or one query is not supported. Leave from and to empty to get the full history that is stored.

Parameters

ParameterTypeRequiredNotes
sitestringYesThe 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.
granularity"daily" | "weekly" | "monthly"NoDefaults to "daily".
fromstringNoStart date (YYYY-MM-DD), inclusive. Omit for full history.
tostringNoEnd date (YYYY-MM-DD), inclusive. Omit for full history.
searchVertical"web" | "image" | "video"NoWhich 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."    },    "granularity": {      "default": "daily",      "type": "string",      "enum": [        "daily",        "weekly",        "monthly"      ]    },    "from": {      "description": "Start date (YYYY-MM-DD), inclusive. Omit for full history.",      "type": "string"    },    "to": {      "description": "End date (YYYY-MM-DD), inclusive. Omit for full history.",      "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"      ]    },    "granularity": {      "type": "string"    },    "points": {      "type": "array",      "items": {        "type": "object",        "properties": {          "date": {            "type": "string"          },          "google": {            "type": "object",            "properties": {              "impressions": {                "anyOf": [                  {                    "type": "integer",                    "minimum": -9007199254740991,                    "maximum": 9007199254740991                  },                  {                    "type": "null"                  }                ]              },              "clicks": {                "anyOf": [                  {                    "type": "integer",                    "minimum": -9007199254740991,                    "maximum": 9007199254740991                  },                  {                    "type": "null"                  }                ]              },              "avgPosition": {                "anyOf": [                  {                    "type": "number"                  },                  {                    "type": "null"                  }                ]              }            },            "additionalProperties": {}          },          "bing": {            "type": "object",            "properties": {              "impressions": {                "anyOf": [                  {                    "type": "integer",                    "minimum": -9007199254740991,                    "maximum": 9007199254740991                  },                  {                    "type": "null"                  }                ]              },              "clicks": {                "anyOf": [                  {                    "type": "integer",                    "minimum": -9007199254740991,                    "maximum": 9007199254740991                  },                  {                    "type": "null"                  }                ]              },              "avgPosition": {                "anyOf": [                  {                    "type": "number"                  },                  {                    "type": "null"                  }                ]              }            },            "additionalProperties": {}          }        },        "required": [          "date",          "google",          "bing"        ],        "additionalProperties": {}      }    },    "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",    "granularity",    "points",    "unsupportedInputs"  ],  "additionalProperties": false}

On This Page