Retrieve Site Performance Data with Google Search Console API

Pipedream makes it easy to connect APIs for Google Search Console and 2,700+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Retrieve Site Performance Data with the Google Search Console API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Retrieve Site Performance Data with the Google Search Console API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Retrieve Site Performance Data action
1. Connect your Google Search Console account
2. Select a Site
3. Configure Start Date (YYYY-MM-DD)
4. Configure End Date (YYYY-MM-DD)
5. Optional- Select one or more Dimensions
6. Optional- Select a Search Type
7. Optional- Select a Aggregation Type
8. Optional- Configure Max Rows
9. Optional- Configure Start Row
10. Optional- Configure Subdomain Filter
11. Optional- Select a Filter Dimension
12. Optional- Select a Filter Operator
13. Optional- Configure Advanced Dimension Filters
14. Optional- Select a Data State
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Retrieve Site Performance Data with Google Search Console API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Google Search Console

Try it

Retrieve Site Performance Data with Google Search Console API on New Submission from Typeform API

Typeform + Google Search Console

Try it

Retrieve Site Performance Data with Google Search Console API on New Submission (Instant) from Jotform API

Jotform + Google Search Console

Try it

Retrieve Site Performance Data with Google Search Console API on New Scheduled Tasks from Pipedream API

Pipedream + Google Search Console

Try it

Retrieve Site Performance Data with Google Search Console API on New Download Counts from npm API

npm + Google Search Console

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Retrieve Site Performance Data on Google Search Console

Description:Fetches search analytics from Google Search Console for a verified site.

Version:0.0.3

Key:google_search_console-retrieve-site-performance-data

View on GitHub

Code#

import googleSearchConsole from "../../google_search_console.app.mjs";
import { trimIfString } from "../../common/utils.mjs";

export default {
  name: "Retrieve Site Performance Data",
  description: "Fetches search analytics from Google Search Console for a verified site.",
  key: "google_search_console-retrieve-site-performance-data",
  version: "0.0.3",
  type: "action",
  props: {
    googleSearchConsole,
    siteUrl: {
      propDefinition: [
        googleSearchConsole,
        "siteUrl",
      ],
      description: "Select a verified site from your Google Search Console. For subdomains, select the domain property and use dimension filters.",
    },
    startDate: {
      type: "string",
      label: "Start Date (YYYY-MM-DD)",
      description: "Start date of the range for which to retrieve site performance data",
    },
    endDate: {
      type: "string",
      label: "End Date (YYYY-MM-DD)",
      description: "End date of the range for which to retrieve site performance data",
    },
    dimensions: {
      type: "string[]",
      label: "Dimensions",
      optional: true,
      description: "e.g. ['query', 'page', 'country', 'device']",
      options: [
        "country",
        "device",
        "page",
        "query",
        "searchAppearance",
        "date",
      ],
    },
    searchType: {
      type: "string",
      label: "Search Type",
      description: "The type of search to use",
      optional: true,
      options: [
        "web",
        "image",
        "video",
        "news",
        "googleNews",
        "discover",
      ],
      default: "web",
    },
    aggregationType: {
      type: "string",
      label: "Aggregation Type",
      description: "The aggregation type to use",
      optional: true,
      options: [
        "auto",
        "byPage",
      ],
    },
    rowLimit: {
      type: "integer",
      label: "Max Rows",
      description: "Max number of rows to return",
      default: 10,
      optional: true,
    },
    startRow: {
      type: "integer",
      label: "Start Row",
      description: "Start row (for pagination)",
      optional: true,
    },
    subdomainFilter: {
      type: "string",
      label: "Subdomain Filter",
      optional: true,
      description: "Filter results to a specific subdomain when using a domain property (e.g., `https://subdomain.example.com`). This will include all subpages of the subdomain.",
    },
    filterDimension: {
      type: "string",
      label: "Filter Dimension",
      optional: true,
      description: "Dimension to filter by (defaults to page when subdomain filter is used). Using 'page' will match the subdomain and all its subpages.",
      options: [
        "country",
        "device",
        "page",
        "query",
      ],
      default: "page",
    },
    filterOperator: {
      type: "string",
      label: "Filter Operator",
      optional: true,
      description: "Operator to use for filtering (defaults to contains when subdomain filter is used)",
      options: [
        "contains",
        "equals",
        "notContains",
        "notEquals",
        "includingRegex",
        "excludingRegex",
      ],
      default: "contains",
    },
    advancedDimensionFilters: {
      type: "object",
      label: "Advanced Dimension Filters",
      optional: true,
      description: "For advanced use cases: custom dimension filter groups following Search Console API structure.",
    },
    dataState: {
      type: "string",
      label: "Data State",
      description: "The data state to use",
      optional: true,
      options: [
        "all",
        "final",
      ],
      default: "final",
    },
  },
  async run({ $ }) {
    const {
      googleSearchConsole,
      siteUrl,
      subdomainFilter,
      filterDimension,
      filterOperator,
      advancedDimensionFilters,
      ...fields
    } = this;

    const body = Object.entries(fields).reduce((acc, [
      key,
      value,
    ]) => {
      acc[key] = trimIfString(value);
      return acc;
    }, {});

    // Build dimension filters based on user input
    let dimensionFilterGroups;

    if (subdomainFilter) {
      // If user provided a subdomain filter, create the filter structure
      dimensionFilterGroups = {
        filterGroups: [
          {
            filters: [
              {
                dimension: filterDimension || "page",
                operator: filterOperator || "contains",
                expression: subdomainFilter,
              },
            ],
          },
        ],
      };
    } else if (advancedDimensionFilters) {
      // If user provided advanced filters, use those
      dimensionFilterGroups = googleSearchConsole.parseIfJsonString(advancedDimensionFilters);
    }

    let response;
    try {
      response = await googleSearchConsole.getSitePerformanceData({
        $,
        url: siteUrl,
        data: {
          ...body,
          dimensionFilterGroups,
        },
      });
    } catch (error) {
      // Identify if the error was thrown by internal validation or by the API call
      const thrower = googleSearchConsole.checkWhoThrewError(error);

      // Add more helpful error messages for common 403 errors
      if (error.response?.status === 403) {
        const message = "Access denied. If you're trying to access a subdomain, select the domain property (sc-domain:example.com) and use the subdomain filter to filter for your subdomain.";
        throw new Error(`Failed to fetch data: ${message}`);
      }

      throw new Error(`Failed to fetch data (${thrower.whoThrew} error): ${error.message}`);
    }

    const rowCount = response.rows?.length || 0;
    $.export("$summary", `Fetched ${rowCount} ${rowCount === 1
      ? "row"
      : "rows"} of data.`);
    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Google Search Console	`googleSearchConsole`	`app`	This component uses the Google Search Console app.
Site	`siteUrl`	`string`	Select a value from the drop down menu.
Start Date (YYYY-MM-DD)	`startDate`	`string`	Start date of the range for which to retrieve site performance data
End Date (YYYY-MM-DD)	`endDate`	`string`	End date of the range for which to retrieve site performance data
Dimensions	`dimensions`	`string[]`	Select a value from the drop down menu:`countrydevicepagequerysearchAppearancedate`
Search Type	`searchType`	`string`	Select a value from the drop down menu:`webimagevideonewsgoogleNewsdiscover`
Aggregation Type	`aggregationType`	`string`	Select a value from the drop down menu:`autobyPage`
Max Rows	`rowLimit`	`integer`	Max number of rows to return
Start Row	`startRow`	`integer`	Start row (for pagination)
Subdomain Filter	`subdomainFilter`	`string`	Filter results to a specific subdomain when using a domain property (e.g., `https://subdomain.example.com`). This will include all subpages of the subdomain.
Filter Dimension	`filterDimension`	`string`	Select a value from the drop down menu:`countrydevicepagequery`
Filter Operator	`filterOperator`	`string`	Select a value from the drop down menu:`containsequalsnotContainsnotEqualsincludingRegexexcludingRegex`
Advanced Dimension Filters	`advancedDimensionFilters`	`object`	For advanced use cases: custom dimension filter groups following Search Console API structure.
Data State	`dataState`	`string`	Select a value from the drop down menu:`allfinal`

Authentication#

Google Search Console uses OAuth authentication. When you connect your Google Search Console account, Pipedream will open a popup window where you can sign into Google Search Console and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Google Search Console API.

Pipedream requests the following authorization scopes when you connect your account:

emailprofilehttps://www.googleapis.com/auth/webmastershttps://www.googleapis.com/auth/webmasters.readonlyhttps://www.googleapis.com/auth/siteverificationhttps://www.googleapis.com/auth/indexing