Retrieve Site Performance Data with Google Search Console API on New Commit Comment from GitHub API

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

Trigger workflow on

New Commit Comment from the GitHub API

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#

This integration creates a workflow with a GitHub trigger and Google Search Console action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Commit Comment trigger
1. Configure eventTypeInfo
2. Connect your GitHub account
3. Select a Repository
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
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

New Commit Comment on GitHub

Description:Emit new event when a commit comment is created

Version:1.0.9

Key:github-new-commit-comment

View on GitHub

GitHub Overview#

The GitHub API is a powerful gateway to interaction with GitHub's vast web of data and services, offering a suite of endpoints to manipulate and retrieve information on repositories, pull requests, issues, and more. Harnessing this API on Pipedream, you can orchestrate automated workflows that respond to events in real-time, manage repository data, streamline collaborative processes, and connect GitHub with other services for a more integrated development lifecycle.

Trigger Code#

import common from "../common/common-flex.mjs";
import {
  getSampleTimerEvent, getSampleWebhookEvent,
} from "./common-sample-events.mjs";

export default {
  ...common,
  key: "github-new-commit-comment",
  name: "New Commit Comment",
  description: "Emit new event when a commit comment is created",
  version: "1.0.9",
  type: "source",
  dedupe: "unique",
  props: {
    eventTypeInfo: {
      type: "alert",
      alertType: "info",
      content: "**Note:** commit comments are not the same as pull request comments. [See the GitHub documentation](https://docs.github.com/en/rest/guides/working-with-comments?apiVersion=2022-11-28) for more information.",
    },
    ...common.props,
  },
  methods: {
    ...common.methods,
    getSampleTimerEvent,
    getSampleWebhookEvent,
    getWebhookEvents() {
      return [
        "commit_comment",
      ];
    },
    shouldEmitWebhookEvent(body) {
      return body?.action === "created";
    },
    getWebhookEventItem(body) {
      return body.comment;
    },
    getSummary(item) {
      return `New comment (${item.id})`;
    },
    getPollingData(args) {
      return this.github.getRepositoryLatestCommitComments(args);
    },
    getHttpDocsLink() {
      return "https://docs.github.com/en/webhooks/webhook-events-and-payloads#commit_comment";
    },
    getTimerDocsLink() {
      return "https://docs.github.com/en/rest/commits/comments?apiVersion=2022-11-28#list-commit-comments-for-a-repository";
    },
  },
};

Trigger 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
GitHub	`github`	`app`	This component uses the GitHub app.
Repository	`repoFullname`	`string`	Select a value from the drop down menu.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

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

reporead:orgadmin:org_hookgistprojectnotificationsread:userwrite:discussionadmin:repo_hook

About GitHub#

Where the world builds software. Millions of developers and companies build, ship, and maintain their software on GitHub—the largest and most advanced development platform in the world.

Action#

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

Google Search Console Overview#

The Google Search Console API opens a treasure trove of data and insights about your website's presence in Google Search results. You can get detailed reports on your site's search traffic, manage and test your site's sitemaps and robots.txt files, and see which queries bring users to your site. On Pipedream, utilize this API to automate checks on site performance, integrate with other tools for deeper analysis, or keep tabs on your SEO strategy's effectiveness.

Working with Domain Properties and Subdomains

Google Search Console distinguishes between URL properties and Domain properties:

URL properties are specific site URLs (e.g., https://example.com or https://www.example.com)
Domain properties include all subdomains and protocols (e.g., sc-domain:example.com)

When working with subdomains:

Select the domain property from the dropdown (e.g., sc-domain:example.com)
Enter the subdomain URL in the "Subdomain Filter" field (e.g., https://mcp.example.com)
By default, this will filter for pages containing that subdomain URL, including all subpages like https://mcp.example.com/app/slack

This approach ensures you can access subdomain data even if the subdomain isn't individually verified in Search Console.

Important: Getting Data for Individual Pages

To see data broken down by individual pages (rather than just aggregate data):

Add "page" to your dimensions list
This will return separate rows for each page, rather than a single aggregated row

For advanced filtering needs, you can also:

Change the filter dimension (page, query, country, etc.)
Change the filter operator (contains, equals, etc.)
Or use the advanced filters for complete customization

Example Use Cases

SEO Performance Report to Slack: Automate daily or weekly SEO performance reports. Use the Google Search Console API to fetch search analytics data, then send a summary report to a Slack channel, keeping the team informed about trends, keyword rankings, and click-through rates.
Sync Search Results with Google Sheets: Create a workflow that periodically pulls data from the Google Search Console API and adds it to a Google Sheet. This is useful for maintaining an evolving dataset for deeper analysis, historical reference, or sharing insights across teams without giving direct access to the Search Console.
Automatic Sitemap Submission: Set up a Pipedream workflow that triggers whenever a new sitemap is generated in your content management system (CMS). The workflow can then automatically submit the sitemap to Google Search Console via API, ensuring Google has the latest structure of your site for crawling and indexing.

Action 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;
  },
};

Action Configuration#

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

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`

Action 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

About Google Search Console#

Tools and reports help you measure your site's Search traffic

More Ways to Connect Google Search Console + GitHub#

Other Popular Integrations#

Submit URL for Indexing with Google Search Console API on New Branch Created from GitHub API

GitHub + Google Search Console