Create Key Event with Google Analytics API on New Monitor Run Completed from Postman API

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

Trigger workflow on

New Monitor Run Completed from the Postman 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 Postman 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 New Monitor Run Completed trigger
1. Connect your Postman account
2. Configure timer
3. Select a Monitor ID
Configure the Create Key Event action
1. Connect your Google Analytics account
2. Configure Parent
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#

New Monitor Run Completed on Postman

Description:Emit new event when a monitor run is completed. [See the documentation](https://learning.postman.com/docs/monitoring-your-api/intro-monitors/)

Version:0.0.1

Key:postman-monitor-run-completed

View on GitHub

Postman Overview#

The Postman API enables you to automate tasks within your Postman collections, such as running collections, fetching and updating environments, and integrating your API development workflow into your CI/CD pipeline. Using Pipedream, you can harness this functionality to create custom workflows that trigger on various events, process data, and connect with other apps, extending the capabilities of your API testing and development processes.

Trigger Code#

import postman from "../../postman.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "postman-monitor-run-completed",
  name: "New Monitor Run Completed",
  description: "Emit new event when a monitor run is completed. [See the documentation](https://learning.postman.com/docs/monitoring-your-api/intro-monitors/)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    postman,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: 60,
      },
    },
    monitorId: {
      propDefinition: [
        postman,
        "monitorId",
      ],
    },
  },
  methods: {
    _getLastDate() {
      return this.db.get("lastDate") || new Date("1970-01-01");
    },
    _setLastDate(lastDate) {
      this.db.set("lastDate", lastDate);
    },
    async startEvent() {
      const lastDate = this._getLastDate();

      const { monitor } = await this.postman.getMonitor({
        monitorId: this.monitorId,
      });

      if (monitor.lastRun?.status === "success" && new Date(monitor.lastRun.startedAt) > new Date(lastDate)) {
        this._setLastDate(monitor.lastRun.startedAt);
        this.emitEvent(monitor);
      }
    },
    emitEvent(monitor) {
      this.$emit(monitor, {
        id: monitor.id + monitor.lastRun.startedAt,
        summary: `Monitor Run Completed: ${monitor.name}`,
        ts: Date.parse(monitor.lastRun.finishedAt),
      });
    },
  },
  async run() {
    await this.startEvent();
  },
  sampleEmit,
};

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
Postman	`postman`	`app`	This component uses the Postman app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Monitor ID	`monitorId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

Postman uses API keys for authentication. When you connect your Postman account, Pipedream securely stores the keys so you can easily authenticate to Postman APIs in both code and no-code steps.

To retrieve your API key,

Navigate to your Postman account and sign in
Go to your Integration Dashboard
Click "Generate API Key", and copy and paste it below.

About Postman#

Postman is the world's leading API platform.

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.1

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.1",
  type: "action",
  props: {
    app,
    parent: {
      type: "string",
      label: "Parent",
      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.
Parent	`parent`	`string`	The resource name of the parent property where this Key Event will be created. Format: `properties/123`
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.edit