Skip to main content
Google Search Console logo
  • Category: analytics
  • Auth: OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 9
  • Triggers: 0
  • Slug: GOOGLE_SEARCH_CONSOLE
  • Version: 20261101_00

Tools

Slug: GOOGLE_SEARCH_CONSOLE_ADD_SITEAdds a site to the set of the user’s sites in Google Search Console. This action registers a new property (site) in Google Search Console for the authenticated user. After adding the site, you will need to verify ownership through one of the available verification methods. The site URL must be properly formatted as either a URL-prefix property (with protocol) or a domain property (with sc-domain prefix).

Input Parameters

string
required
The site URL to add to Google Search Console. For URL-prefix properties, use the full URL with protocol (e.g., ‘https://www.example.com/’). For domain properties, use the sc-domain format (e.g., ‘sc-domain:example.com’). The site will need to be verified after being added.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_SEARCH_CONSOLE_DELETE_SITERemoves a site property from the authenticated user’s Google Search Console account.

Input Parameters

string
required
The site URL to remove from Google Search Console. For URL-prefix properties, use the full URL with protocol (e.g., ‘http://www.example.com/’). For domain properties, use the sc-domain format (e.g., ‘sc-domain:example.com’). The site must be currently registered in Search Console for the authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_SEARCH_CONSOLE_GET_SITERetrieves information about a specific Search Console site. Use when you need to get site details including permission level for a specific property.

Input Parameters

string
required
The URL of the property to retrieve, as defined by Search Console. Examples: http://www.example.com/ (for a URL-prefix property) or sc-domain:example.com (for a Domain property).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_SEARCH_CONSOLE_GET_SITEMAPRetrieves metadata for a specific sitemap in Search Console, including submitted counts, errors, warnings, and submission timestamps. Returns metadata only, not raw XML content; the indexed count field is deprecated.

Input Parameters

string
required
The URL of the sitemap to retrieve. For example: https://www.example.com/sitemap.xml
string
required
The site’s URL, including protocol. For example: https://www.example.com/ For domain properties, use sc-domain:example.com format instead.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_SEARCH_CONSOLE_INSPECT_URLInspects a URL for indexing issues and status in Google Search Console. Results may reflect cached data lagging real changes by several days. High-volume use can trigger 429 quota errors; limit to priority URLs.

Input Parameters

string
required
The URL of the property as defined in Search Console. URL-prefix properties must include a trailing slash. For example: https://www.example.com/
string
IETF BCP-47 language code for localizing the inspection results. For example: en-US, es-ES, fr-FR
string
required
The fully-qualified URL to inspect. Must be a page under the site specified in site_url. For example: https://www.example.com/page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_SEARCH_CONSOLE_LIST_SITEMAPSLists sitemap entries submitted for a site in Google Search Console, or those contained in a specified sitemap index. Response fields errors, warnings, contents.submitted, and contents.indexed may be returned as strings; cast them to integers before numeric operations and evaluate them alongside isPending for sitemap health.

Input Parameters

string
required
The site’s URL, including protocol. For example: https://www.example.com/ Must exactly match the Search Console property string — include trailing slash for URL-prefix properties or use sc-domain:example.com format for domain properties. An inexact match silently returns no data.
string
A URL of a site’s sitemap index file (e.g., http://www.example.com/sitemapindex.xml). When specified, lists the sitemaps contained within this sitemap index file instead of all sitemaps for the site.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_SEARCH_CONSOLE_LIST_SITESLists Google Search Console sites associated with the authenticated user, with permission levels when provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_SEARCH_CONSOLE_SEARCH_ANALYTICS_QUERYQueries Google Search Console for search analytics data including clicks, impressions, CTR, and average position, grouped and filtered by requested dimensions. Results may contain only top rows; missing rows do not confirm non-indexing.

Input Parameters

string
required
The end date of the date range for the query, in YYYY-MM-DD format.
string
required
The site’s URL, including protocol (e.g., https://www.example.com/) or a domain property (e.g., sc-domain:example.com). URL-prefix properties specify exact protocol and path, while domain properties aggregate data across all subdomains and protocols.
integer
The maximum number of rows to return. Must be between 1 and 25,000. Note: The API returns top results sorted by clicks (or date when grouping by date). Must be between 1 and 5000. Use start_row to paginate; stop when response rows < row_limit.
integer
The first row to return from the result set. Used for pagination.
string ("final" | "all" | "hourly_all")
The data state to return.
array
The dimensions to group the data by. Results are sorted by clicks descending, except when grouping by date (sorted by date ascending).
string
required
The start date of the date range for the query, in YYYY-MM-DD format. Data lags 2–3 days (UTC); most recent 1–2 days may be incomplete. Data retention is ~16 months; older ranges return zero rows.
string ("web" | "image" | "video" | "news" | "discover" | "googleNews")
The search type to filter results by.
string ("auto" | "byPage" | "byProperty" | "byNewsShowcasePanel")
How data is aggregated.
array
Optional filters to apply to dimensions. Each filter group contains an array of filters with structure: [{‘filters’: [{‘dimension’: ‘country’, ‘operator’: ‘equals’, ‘expression’: ‘USA’}]}]. Operators: equals, notEquals, contains, notContains, includingRegex, excludingRegex. Invalid dimension names, unsupported operators, or mismatched expressions return zero rows without an error — verify each filter before trusting empty results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_SEARCH_CONSOLE_SUBMIT_SITEMAPSubmits a sitemap to Google Search Console for indexing. This action registers or resubmits a sitemap for a verified property in Google Search Console. The sitemap file must be accessible at the specified URL and properly formatted as XML. Supported sitemap types include standard sitemaps, sitemap index files, RSS feeds, and Atom feeds. The authenticated user must have site owner or full user permissions for the property. After submission, Google will crawl and process the sitemap according to its standard indexing schedule.

Input Parameters

string
required
The full URL of the sitemap to submit (e.g., ‘https://www.example.com/sitemap.xml’). Must be accessible and properly formatted as a valid sitemap XML file. Can also be a sitemap index file or RSS/Atom feed URL. Must exactly match the registered sitemap URL including protocol, host, path, and trailing slash; mismatches return notFound or invalid errors.
string
required
The site URL as registered in Google Search Console. For URL-prefix properties, use the full URL with protocol (e.g., ‘https://www.example.com/’). For domain properties, use the sc-domain format (e.g., ‘sc-domain:example.com’). The site must be verified and owned by the authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not