Google Search Console API

Google Search Console is a free Google service that helps you monitor, maintain, and troubleshoot your site's presence in Google Search results. Its Search Console API (Webmaster Tools API v3) exposes your verified properties, submitted sitemaps, and Search Analytics performance data — impressions, clicks, click-through rate, and average position — broken down by query, page, country, and device. This connector uses OAuth 2.0 to read that data into Nexla for reporting and analysis.

Power end-to-end data operations for your Google Search Console API API with Nexla. Our bi-directional Google Search Console API connector is purpose-built for Google Search Console API, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Google Search Console API or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Google Search Console API workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Nexla connects to the Google Search Console API using OAuth 2.0. Nexla provides and manages the OAuth application (client ID and client secret), so you do not need to register your own application in the Google API Console. When you create the credential, Nexla redirects you to Google to sign in and grant access, and the resulting access and refresh tokens are stored securely with your credential.

Before creating a Google Search Console credential in Nexla, confirm the following:

1. You have a Google account that can sign in during the OAuth authorization flow.

2. That Google account has access to the Search Console properties you want to read. In Search Console, an account must be added to a property as an Owner or with Full permission to retrieve data through the API. To review or grant access, open Google Search Console, select the property, and go to Settings > Users and permissions.

3. The properties you intend to query are verified in Search Console. The API returns data only for verified properties associated with the authenticated account.

4. You know the siteUrl for each property you want to query, in the exact form Search Console uses. URL-prefix properties look like https://www.example.com/ and Domain properties look like sc-domain:example.com. When you configure a source, this value must be URL-encoded (for example, https%3A%2F%2Fwww.example.com%2F or sc-domain%3Aexample.com).

The credential requests the read-only scope https://www.googleapis.com/auth/webmasters.readonly, which allows Nexla to view Search Console data for the authenticated account's verified sites. For complete details on the API, authorization, and available methods, see the Search Console API reference.

Authenticate

Credentials required

Field	Required	Secret	Description
API Version	Yes	No	Google Search Console API Version that your wish to use.

Create a credential in Nexla

1. After selecting the data source type, click the Add Credential tile to open the Add New Credential overlay.

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Confirm the API Version field. This is the Google Search Console (Webmaster Tools) API version that requests will target, and it defaults to v3. Leave the default value unless you have a specific reason to change it.

4. Click the button to authenticate with Google. You will be redirected to Google to sign in with a Google account that has access to your Search Console properties, and to grant Nexla read-only access to your Search Console data. After you approve, you are returned to Nexla and the credential captures the resulting OAuth tokens.

   Sign in with a Google account that has been added to the target Search Console properties as an Owner or with Full permission. The API returns data only for verified properties that this account can access.

   Nexla requests the read-only scope https://www.googleapis.com/auth/webmasters.readonly, so this credential can view Search Console data but cannot modify your properties or settings.

5. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Google Search Console API connector tile, then select the credential that will be used to connect to Google Search Console, and click Next; or, create a new Google Search Console credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Google Search Console endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

Reports that query Search Analytics accept a start date and end date (in YYYY-MM-DD format), and the reporting endpoints automatically page through all matching rows. The site-level and keyword reports also require the property's URL-encoded siteUrl.

[Rest API] List Sites (Properties)

List Search Console properties available to the authenticated user.

• This endpoint returns the set of properties (sites) that the authenticated account can access. Use it to discover the exact siteUrl values you will supply to the sitemap and report endpoints.

For details on the response fields, see the Search Console API: Sites list reference.

[Rest API] List Sitemaps

List sitemaps for a specific Search Console property (siteUrl).

• Enter the property's URL-encoded Site URL (URL-encoded) value (for example, sc-domain%3Aexample.com or https%3A%2F%2Fwww.example.com%2F) to list the sitemaps submitted for that property.

For details on the response fields, see the Search Console API: Sitemaps list reference.

[Rest API] Search Analytics Report

Run a Search Analytics report. Automatically pages through all results.

• Provide the URL-encoded Site URL (URL-encoded), a Start date (YYYY-MM-DD), an End date (YYYY-MM-DD), and a Dimensions (JSON array) value such as ["date"], ["date","query"], or ["date","country","device"]. Nexla pages through all matching rows automatically.

For details on request parameters, dimensions, and response fields, see the Search Console API: Search Analytics query reference.

[Rest API] Site Report (By Property)

Site-level performance report aggregated by date, country, device, and search appearance.

• Provide the URL-encoded Site URL (URL-encoded), a Start date (YYYY-MM-DD), and an End date (YYYY-MM-DD). This report aggregates Search Analytics data by date, country, and device at the property level.

For details on request parameters and response fields, see the Search Console API: Search Analytics query reference.

[Rest API] Site Report (By Page)

Site-level performance report aggregated by date, country, device, and search appearance (page-level view).

• Provide the URL-encoded Site URL (URL-encoded), a Start date (YYYY-MM-DD), and an End date (YYYY-MM-DD). This report uses page-level aggregation of Search Analytics data by date, country, and device.

For details on request parameters and response fields, see the Search Console API: Search Analytics query reference.

[Rest API] Page Report

Detailed page-level performance report with date, page, country, device, and search appearance dimensions.

• Provide the URL-encoded Site URL (URL-encoded), a Start date (YYYY-MM-DD), and an End date (YYYY-MM-DD). This report breaks Search Analytics data down by date, page, country, and device.

For details on request parameters and response fields, see the Search Console API: Search Analytics query reference.

[Rest API] Keyword Report (By Property)

Keyword performance report aggregated by date, query, country, device, and search appearance at the site level.

• Provide the URL-encoded Site URL (URL-encoded), a Start date (YYYY-MM-DD), and an End date (YYYY-MM-DD). This report aggregates Search Analytics data by date, query, country, and device at the property level.

For details on request parameters and response fields, see the Search Console API: Search Analytics query reference.

[Rest API] Keyword Report (By Page)

Keyword performance report aggregated by date, query, country, device, and search appearance (page-level view).

• Provide the URL-encoded Site URL (URL-encoded), a Start date (YYYY-MM-DD), and an End date (YYYY-MM-DD). This report uses page-level aggregation of Search Analytics data by date, query, country, and device.

For details on request parameters and response fields, see the Search Console API: Search Analytics query reference.

[Rest API] Keyword Page Report (Detailed)

Most detailed keyword report with date, page, query, country, device, and search appearance dimensions.

• Provide the URL-encoded Site URL (URL-encoded), a Start date (YYYY-MM-DD), and an End date (YYYY-MM-DD). This is the most granular report, breaking Search Analytics data down by date, page, query, country, and device.

For details on request parameters and response fields, see the Search Console API: Search Analytics query reference.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Google Search Console data sources can also be manually configured to ingest data from any valid Search Console API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Google Search Console data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.