Create Key Event with Google Analytics API on Custom Interval from Schedule API

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

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

Create Key Event 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#

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

Select this integration
Configure the Custom Interval trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Create Key Event action
1. Connect your Google Analytics account
2. Select a Property
3. Configure Event Name
4. Select a Counting Method
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#

Custom Interval on Schedule

Description:Trigger your workflow every N hours, minutes or seconds.

Version:0.0.2

Key:schedule-custom-interval

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

import schedule from "../../schedule.app.mjs";

export default {
  name: "Custom Interval",
  version: "0.0.2",
  key: "schedule-custom-interval",
  type: "source",
  description: "Trigger your workflow every N hours, minutes or seconds.",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
    },
  },
};

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
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Create Key Event on Google Analytics

Description:Creates a new key event. [See the documentation](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1beta/properties.keyEvents/create)

Version:0.0.3

Key:google_analytics-create-key-event

View on GitHub

Google Analytics Overview#

The Google Analytics API unlocks the power of your analytics data, enabling automated access to custom reports, real-time statistics, and user behavior analysis. With it, you can extract actionable insights, push data to other platforms, and tailor your business strategy with precision. Leveraging Pipedream's serverless platform, these capabilities can be seamlessly integrated into workflows that trigger actions in other apps, send alerts, or even feed data warehouses for deeper analysis.

Action Code#

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

export default {
  key: "google_analytics-create-key-event",
  name: "Create Key Event",
  description: "Creates a new key event. [See the documentation](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1beta/properties.keyEvents/create)",
  version: "0.0.3",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    app,
    parent: {
      propDefinition: [
        app,
        "property",
      ],
      description: "The resource name of the parent property where this Key Event will be created. Format: `properties/123`",
    },
    eventName: {
      type: "string",
      label: "Event Name",
      description: "Immutable. The event name for this key event. Examples: `click`, `purchase`",
    },
    countingMethod: {
      type: "string",
      label: "Counting Method",
      description: "The method by which Key Events will be counted across multiple events within a session.",
      options: [
        {
          label: "Counting method not specified.",
          value: "COUNTING_METHOD_UNSPECIFIED",
        },
        {
          label: "Each Event instance is considered a Key Event.",
          value: "ONCE_PER_EVENT",
        },
        {
          label: "An Event instance is considered a Key Event at most once per session per user.",
          value: "ONCE_PER_SESSION",
        },
      ],
    },
  },
  methods: {
    createKeyEvent({
      parent, ...args
    } = {}) {
      return this.app.post({
        path: `/${parent}/keyEvents`,
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      createKeyEvent,
      parent,
      eventName,
      countingMethod,
    } = this;

    const response = await createKeyEvent({
      $,
      parent,
      data: {
        eventName,
        countingMethod,
      },
    });

    $.export("$summary", `Successfully created key event with name ${eventName} and counting method ${countingMethod} in parent ${parent}`);
    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 Analytics	`app`	`app`	This component uses the Google Analytics app.
Property	`parent`	`string`	Select a value from the drop down menu.
Event Name	`eventName`	`string`	Immutable. The event name for this key event. Examples: `click`, `purchase`
Counting Method	`countingMethod`	`string`	Select a value from the drop down menu:`{ "label": "Counting method not specified.", "value": "COUNTING_METHOD_UNSPECIFIED" }{ "label": "Each Event instance is considered a Key Event.", "value": "ONCE_PER_EVENT" }{ "label": "An Event instance is considered a Key Event at most once per session per user.", "value": "ONCE_PER_SESSION" }`

Action 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.edithttps://www.googleapis.com/auth/analytics.readonly

Try it

Run Report with Google Analytics API on Weekly schedule from Schedule API

Schedule + Google Analytics

Try it

Run Report with Google Analytics API on Custom Interval from Schedule API

Schedule + Google Analytics

Try it

Run Report with Google Analytics API on Monthly Schedule from Schedule API

Schedule + Google Analytics

Try it

Run Report in GA4 with Google Analytics API on Custom Interval from Schedule API

Schedule + Google Analytics

Try it

Popular Triggers#

Custom Interval from the Schedule API

Trigger your workflow every N hours, minutes or seconds.

Try it

Daily schedule from the Schedule API

Trigger your workflow every day.

Try it

Monthly Schedule from the Schedule API

Trigger your workflow on one or more days each month at a specific time (with timezone support).

Try it

Weekly schedule from the Schedule API

Trigger your workflow on one or more days each week at a specific time (with timezone support).

Try it

New Page Opened from the Google Analytics API

Emit new event when a page is viewed

Try it

Popular 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 with the Google Analytics API

Return report metrics based on a start and end date. 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

Try it