Check for existence of key with Data Stores API on New Page Opened from Google Analytics API

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

Trigger workflow on

New Page Opened from the Google Analytics API

Next, do this

Check for existence of key with the Data Stores 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 Google Analytics trigger and Data Stores action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Page Opened trigger
1. Connect your Google Analytics account
2. Configure timer
3. Configure View Id
Configure the Check for existence of key action
1. Connect your Data Stores account
2. Configure Data Store
3. Select a Key
4. Optional- Select a Create a new record if the key is not found?
5. Optional- Configure Time to Live (TTL)
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 Page Opened on Google Analytics

Description:Emit new event when a page is viewed

Version:0.1.1

Key:google_analytics-page-opened

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.

Trigger Code#

import analytics from "../../google_analytics.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import utils from "../../common/utils.mjs";

export default {
  key: "google_analytics-page-opened",
  version: "0.1.1",
  name: "New Page Opened",
  description: "Emit new event when a page is viewed",
  type: "source",
  dedupe: "unique",
  props: {
    analytics,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    viewId: {
      propDefinition: [
        analytics,
        "viewId",
      ],
    },
  },
  hooks: {
    async deploy() {
      const startDate = utils.monthAgo();
      this._setStartDate(startDate);
      await this.processEvent();
    },
  },
  methods: {
    _getPageViews() {
      return this.db.get("pageViews");
    },
    _setPageViews(pageViews) {
      this.db.set("pageViews", pageViews);
    },
    _getStartDate() {
      return this.db.get("startDate");
    },
    _setStartDate(startDate) {
      this.db.set("startDate", startDate);
    },
    generateMeta(pageViews, startDate) {
      const ts = Date.now();
      return {
        id: ts,
        summary: `${pageViews} page views since ${startDate}`,
        ts,
      };
    },
    async processEvent() {
      const startDate = this._getStartDate();
      const data = {
        resource: {
          reportRequests: [
            {
              viewId: this.viewId,
              dateRanges: [
                {
                  startDate,
                  endDate: "today",
                },
              ],
              metrics: [
                {
                  expression: "ga:pageviews",
                },
              ],
            },
          ],
        },
      };
      const { data: report } = await this.analytics.queryReports(data);

      const previousPageViews = this._getPageViews();
      const pageViews = report.reports[0].data.totals[0].values[0];

      if (!previousPageViews || pageViews > previousPageViews) {
        this._setPageViews(pageViews);
        const meta = this.generateMeta(pageViews, startDate);
        this.$emit(report, meta);
      }
    },
  },
  async run() {
    await this.processEvent();
  },
};

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
Google Analytics	`analytics`	`app`	This component uses the Google Analytics app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
View Id	`viewId`	`string`	ID of the view to monitor. Can be found on your Google Analytics Dashboard -> Admin -> View Setting

Trigger 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

About Google Analytics#

Google Analytics enables you to measure and report on user activity on websites, web and mobile apps, and internet-connected devices.

Action#

Check for existence of key on Data Stores

Description:Check if a key exists in your [Pipedream Data Store](https://pipedream.com/data-stores/) or create one if it doesn't exist.

Version:0.1.4

Key:data_stores-has-key-or-create

View on GitHub

Data Stores Overview#

Data Stores are a key-value store that allow you to persist state and share data across workflows. You can perform CRUD operations, enabling dynamic data management within your serverless architecture. Use it to save results from API calls, user inputs, or interim data; then read, update, or enrich this data in subsequent steps or workflows. Data Stores simplify stateful logic and cross-workflow communication, making them ideal for tracking process statuses, aggregating metrics, or serving as a simple configuration store.

Action Code#

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

export default {
  key: "data_stores-has-key-or-create",
  name: "Check for existence of key",
  description: "Check if a key exists in your [Pipedream Data Store](https://pipedream.com/data-stores/) or create one if it doesn't exist.",
  version: "0.1.4",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  type: "action",
  props: {
    app,
    dataStore: {
      propDefinition: [
        app,
        "dataStore",
      ],
    },
    key: {
      propDefinition: [
        app,
        "key",
        ({ dataStore }) => ({
          dataStore,
        }),
      ],
      description: "Enter the key you'd like to check.",
    },
    addRecordIfNotFound: {
      propDefinition: [
        app,
        "addRecordIfNotFound",
      ],
    },
    ttl: {
      propDefinition: [
        app,
        "ttl",
      ],
    },
  },
  async additionalProps() {
    const props = {};
    if (this.app.shouldAddRecord(this.addRecordIfNotFound)) {
      props.value = app.propDefinitions.value;
    }
    return props;
  },
  async run({ $ }) {
    if (await this.dataStore.has(this.key)) {
      $.export("$summary", `Key \`${this.key}\` exists.`);

      return {
        existingKeyFound: true,
        newKeyCreated: false,
      };
    }

    if (!this.app.shouldAddRecord(this.addRecordIfNotFound)) {
      $.export("$summary", `Key \`${this.key}\` does not exist.`);

      return {
        existingKeyFound: false,
        newKeyCreated: false,
      };
    }

    const parsedValue = this.app.parseValue(this.value);

    if (this.ttl) {
      await this.dataStore.set(this.key, parsedValue, {
        ttl: this.ttl,
      });
      $.export("$summary", `Key \`${this.key}\` was not found. Successfully added a new record (expires in ${this.app.formatTtl(this.ttl)}).`);
    } else {
      await this.dataStore.set(this.key, parsedValue);
      $.export("$summary", `Key \`${this.key}\` was not found. Successfully added a new record.`);
    }

    return {
      existingKeyFound: false,
      newKeyCreated: true,
      value: parsedValue,
      ttl: this.ttl || null,
    };
  },
};

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
Data Stores	`app`	`app`	This component uses the Data Stores app.
Data Store	`dataStore`	`data_store`	Select an existing Data Store or create a new one.
Key	`key`	`string`	Select a value from the drop down menu.
Create a new record if the key is not found?	`addRecordIfNotFound`	`string`	Select a value from the drop down menu:`YesNo`
Time to Live (TTL)	`ttl`	`integer`	The number of seconds until this record expires and is automatically deleted. Examples: 3600 (1 hour), 86400 (1 day), 604800 (1 week). Leave blank for records that should not expire.

Try it

List keys with Data Stores API on Page Opened from Google Analytics API

Google Analytics + Data Stores

Try it

List Records with Data Stores API on Page Opened from Google Analytics API

Google Analytics + Data Stores

Try it

Add or update multiple records with Data Stores API on Page Opened from Google Analytics API

Google Analytics + Data Stores

Try it

Add or update a single record with Data Stores API on Page Opened from Google Analytics API

Google Analytics + Data Stores

Try it

Popular Triggers#

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

Add or update a single record with the Data Stores API

Add or update a single record in your Pipedream Data Store

Try it