Retrieve Site Performance Data with Google Search Console API on New Action Performed from PostHog API

import posthog from "../../posthog.app.mjs"; import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform"; export default { key: "posthog-new-action-performed", name: "New Action Performed", description: "Emit new event when an action is performed in a project. [See the documentation](https://posthog.com/docs/api/query#post-api-projects-project_id-query)", version: "0.0.1", type: "source", dedupe: "unique", props: { posthog, db: "$.service.db", timer: { type: "$.interface.timer", default: { intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL, }, }, organizationId: { propDefinition: [ posthog, "organizationId", ], }, projectId: { propDefinition: [ posthog, "projectId", (c) => ({ organizationId: c.organizationId, }), ], }, }, hooks: { async deploy() { await this.processEvent(25); }, }, methods: { _getLastTs() { return this.db.get("lastTs"); }, _setLastTs(lastTs) { this.db.set("lastTs", lastTs); }, emitEvent(event) { const meta = this.generateMeta(event); this.$emit(event, meta); }, generateMeta(event) { return { id: event.uuid, summary: `New ${event.event} event`, ts: Date.parse(event.timestamp), }; }, buildQuery(limit) { const lastTs = this._getLastTs(); let query = "SELECT * FROM events"; if (lastTs) { query += ` WHERE timestamp > '${lastTs}'`; } query += " ORDER BY timestamp DESC"; if (limit) { query += ` LIMIT ${limit}`; } return query; }, formatEvents(columns, results) { return results.map((result) => { const values = {}; for (let i = 0; i < columns.length; i++) { values[columns[i]] = result[i]; } return values; }); }, async processEvent(limit) { const { columns, results, } = await this.posthog.createQuery({ projectId: this.projectId, data: { query: { kind: "HogQLQuery", query: this.buildQuery(limit), }, }, }); const events = this.formatEvents(columns, results); if (!events?.length) { return; } this._setLastTs(events[0].timestamp.slice(0, 19)); events.reverse().forEach((event) => this.emitEvent(event)); }, }, async run() { await this.processEvent(); }, };

Label	Prop	Type	Description
PostHog	`posthog`	`app`	This component uses the PostHog app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Organization ID	`organizationId`	`string`	Select a value from the drop down menu.
Project ID	`projectId`	`string`	Select a value from the drop down menu.

Label

Prop

Type

Description

PostHog

posthog

app

This component uses the PostHog app.

N/A

db

$.service.db

This component uses $.service.db to maintain state between executions.

timer

$.interface.timer

Organization ID

organizationId

string

Select a value from the drop down menu.

Project ID

projectId

string

Select a value from the drop down menu.

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.

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

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`

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

Retrieve Site Performance Data with Google Search Console API on New Action Performed from PostHog API

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

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

Developers ♥ Pipedream

Getting Started#

Details#

Trigger#

PostHog Overview#

Trigger Code#

Trigger Configuration#

Trigger Authentication#

About PostHog#

Action#

Google Search Console Overview#

Working with Domain Properties and Subdomains

Important: Getting Data for Individual Pages

Example Use Cases

Action Code#

Action Configuration#

Action Authentication#

About Google Search Console#

More Ways to Connect Google Search Console + PostHog#

Other Popular Integrations#

Popular Triggers#

Popular Actions#

Explore Other Apps#

1
-
24
of
2,500+
apps by most popular

Retrieve Site Performance Data with Google Search Console API on New Action Performed from PostHog API

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

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

Developers ♥ Pipedream

Working with Domain Properties and Subdomains

Important: Getting Data for Individual Pages

Example Use Cases

1-24of2,500+apps by most popular

1
-
24
of
2,500+
apps by most popular