Google Search Console Tools

6 tools • OpenAPI spec ↗

MCPREST

GETlist_sites/sites

List all Search Console sites (properties) the authenticated user has access to.

Request

No input parameters.

Response

siteEntryobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "google-searchconsole",
      "method": "list_sites"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_google-searchconsole",
    "arguments": {
      "method": "list_sites",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/google-searchconsole/sites
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "siteEntry": null
}

GETget_site/sites/:siteUrl

Get information about a specific Search Console site (property).

Request

Path Parameters

Name	Type	Required	Description
siteUrl	string	Yes	The URL of the site to retrieve. For domain properties use 'sc-domain:example.com'. For URL-prefix properties use the full URL including protocol.

Response

siteUrlobject

permissionLevelobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "google-searchconsole",
      "method": "get_site"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_google-searchconsole",
    "arguments": {
      "method": "get_site",
      "params": {
        "siteUrl": "<siteUrl>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/google-searchconsole/sites/:siteUrl
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "siteUrl": null,
  "permissionLevel": null
}

POSTquery_search_analytics/sites/:siteUrl/search-analytics/query

Query search traffic data for a site. Returns clicks, impressions, CTR, and position data. Supports filtering by dimensions (query, page, country, device, searchAppearance, date), date ranges, and more.

Request

Path Parameters

Name	Type	Required	Description
siteUrl	string	Yes	The URL of the site to query. For domain properties use 'sc-domain:example.com'.

Query Parameters

Name	Type	Required	Description
startDate	string	No	Start date in YYYY-MM-DD format (required).
endDate	string	No	End date in YYYY-MM-DD format (required).
dimensions	array	No	Dimensions to group by: query, page, country, device, searchAppearance, date.
type	string	No	Search type filter: web, image, video, news, discover, googleNews.
rowLimit	number	No	Maximum number of rows to return (default 1000, max 25000).
startRow	number	No	Zero-based index of the first row to return.
dimensionFilterGroups	array	No	Array of dimension filter groups. Each group has a groupType and filters array.
aggregationType	string	No	How data is aggregated: auto, byPage, or byProperty.
dataState	string	No	Data freshness: final (default) or all (includes fresh/partial data).

Response

rowsobject

responseAggregationTypeobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "google-searchconsole",
      "method": "query_search_analytics"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_google-searchconsole",
    "arguments": {
      "method": "query_search_analytics",
      "params": {
        "siteUrl": "<siteUrl>"
      }
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/google-searchconsole/sites/:siteUrl/search-analytics/query
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "rows": null,
  "responseAggregationType": null
}

GETlist_sitemaps/sites/:siteUrl/sitemaps

List the sitemaps submitted for a site.

Request

Path Parameters

Name	Type	Required	Description
siteUrl	string	Yes	The URL of the site. For domain properties use 'sc-domain:example.com'.

Query Parameters

Name	Type	Required	Description
sitemapIndex	string	No	A URL of a sitemap index file to filter results to sitemaps referenced by that index.

Response

sitemapobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "google-searchconsole",
      "method": "list_sitemaps"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_google-searchconsole",
    "arguments": {
      "method": "list_sitemaps",
      "params": {
        "siteUrl": "<siteUrl>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/google-searchconsole/sites/:siteUrl/sitemaps
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "sitemap": null
}

GETget_sitemap/sites/:siteUrl/sitemaps/:feedpath

Get information about a specific sitemap.

Request

Path Parameters

Name	Type	Required	Description
siteUrl	string	Yes	The URL of the site. For domain properties use 'sc-domain:example.com'.
feedpath	string	Yes	The URL of the sitemap to retrieve.

Response

pathobject

typeobject

lastSubmittedobject

lastDownloadedobject

isPendingobject

isSitemapsIndexobject

warningsobject

errorsobject

contentsobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "google-searchconsole",
      "method": "get_sitemap"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_google-searchconsole",
    "arguments": {
      "method": "get_sitemap",
      "params": {
        "siteUrl": "<siteUrl>",
        "feedpath": "<feedpath>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/google-searchconsole/sites/:siteUrl/sitemaps/:feedpath
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "path": null,
  "type": null,
  "lastSubmitted": null,
  "lastDownloaded": null,
  "isPending": null,
  "isSitemapsIndex": null,
  "warnings": null,
  "errors": null,
  "contents": null
}

POSTinspect_url/url-inspection/inspect

Inspect a URL to get its index status, AMP status, mobile usability, and rich results status. Requires the full URL and site URL.

Request

Query Parameters

Name	Type	Required	Description
inspectionUrl	string	No	The fully-qualified URL to inspect (required).
siteUrl	string	No	The URL of the property as defined in Search Console. For domain properties use 'sc-domain:example.com' (required).
languageCode	string	No	IETF BCP-47 language code for translated issue messages.

Response

inspectionResultobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "google-searchconsole",
      "method": "inspect_url"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_google-searchconsole",
    "arguments": {
      "method": "inspect_url",
      "params": {}
    }
  }
}

Request

POST https://app.ferrule.io/api/v1/google-searchconsole/url-inspection/inspect
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "inspectionResult": null
}