Run Report with Google Analytics API

Pipedream makes it easy to connect APIs for Google Analytics and 2,400+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Run Report with the Google Analytics 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 Run Report with the Google Analytics API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Run Report action
1. Connect your Google Analytics account
2. Configure View Id
3. Configure Start Date
4. Configure End Date
5. Configure Metrics
6. Optional- Configure Dimensions
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#

Run Report with Google Analytics API on New Monitor Run Completed from Postman API

Postman + Google Analytics

Try it

Run Report with Google Analytics API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Google Analytics

Try it

Run Report with Google Analytics API on New Item in Feed from RSS API

RSS + Google Analytics

Try it

Run Report with Google Analytics API on New Submission from Typeform API

Typeform + Google Analytics

Try it

Run Report with Google Analytics API on Custom Events from Zoom API

Zoom + Google Analytics

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.

Run Report on Google Analytics

Description:Return report metrics based on a start and end date. [See the docs here](https://developers.google.com/analytics/devguides/reporting/core/v4/rest?hl=en)

Version:0.1.0

Key:google_analytics-run-report

View on GitHub

Code#

import analytics from "../../google_analytics.app.mjs";

export default {
  key: "google_analytics-run-report",
  version: "0.1.0",
  name: "Run Report",
  description: "Return report metrics based on a start and end date. [See the docs here](https://developers.google.com/analytics/devguides/reporting/core/v4/rest?hl=en)",
  type: "action",
  props: {
    analytics,
    viewId: {
      propDefinition: [
        analytics,
        "viewId",
      ],
    },
    startDate: {
      type: "string",
      label: "Start Date",
      description: "Start date in YYYY-MM-DD format",
    },
    endDate: {
      type: "string",
      label: "End Date",
      description: "End date in YYYY-MM-DD format",
    },
    metrics: {
      type: "string[]",
      label: "Metrics",
      description: "Metrics attributes for your data. Explore the available metrics and dimensions [here](https://ga-dev-tools.web.app/dimensions-metrics-explorer/)",
    },
    dimensions: {
      type: "string[]",
      label: "Dimensions",
      description: "Dimension attributes for your data. Explore the available metrics and dimensions [here](https://ga-dev-tools.web.app/dimensions-metrics-explorer/)",
      optional: true,
    },
  },
  async run({ $ }) {
    const metrics = this.metrics || [];
    const dimensions = this.dimensions || [];

    const data = {
      resource: {
        reportRequests: [
          {
            viewId: this.viewId,
            dateRanges: [
              {
                startDate: this.startDate,
                endDate: this.endDate,
              },
            ],
            dimensions: dimensions.map((dimension) => ({
              name: dimension,
            })),
            metrics: metrics.map((metric) => ({
              expression: metric,
            })),
          },
        ],
      },
    };
    const { data: report } = await this.analytics.queryReports(data);
    $.export("$summary", `Successfully retrieved report for view with ID ${this.viewId}`);
    return report;
  },
};

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 Analytics	`analytics`	`app`	This component uses the Google Analytics app.
View Id	`viewId`	`string`	ID of the view to monitor. Can be found on your Google Analytics Dashboard -> Admin -> View Setting
Start Date	`startDate`	`string`	Start date in YYYY-MM-DD format
End Date	`endDate`	`string`	End date in YYYY-MM-DD format
Metrics	`metrics`	`string[]`	Metrics attributes for your data. Explore the available metrics and dimensions here
Dimensions	`dimensions`	`string[]`	Dimension attributes for your data. Explore the available metrics and dimensions here

Authentication#

Google Analytics uses OAuth authentication. When you connect your Google Analytics account, Pipedream will open a popup window where you can sign into Google Analytics 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 Analytics API.

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

emailprofilehttps://www.googleapis.com/auth/analytics.edit

Try it

Actions#

Create GA4 Property with the Google Analytics API

Creates a new GA4 property. See the documentation

Try it

Create Key Event with the Google Analytics API

Creates a new key event. See the documentation

Try it

Run Report in GA4 with the Google Analytics API

Returns a customized report of your Google Analytics event data. Reports contain statistics derived from data collected by the Google Analytics tracking code. See the documentation here

Try it