Record page views on your website with Segment API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Record page views on your website with the Segment 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 Record page views on your website with the Segment API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Record page views on your website action
1. Connect your Segment account
2. Optional- Configure Anonymous ID
3. Optional- Configure Context
4. Optional- Configure Integrations
5. Optional- Configure Page Name
6. Optional- Configure Page Properties
7. Optional- Configure Timestamp
8. Optional- Configure User ID
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#

Record page views on your website with Segment API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Segment

Try it

Record page views on your website with Segment API on New Item in Feed from RSS API

RSS + Segment

Try it

Record page views on your website with Segment API on New Message from Discord API

Discord + Segment

Try it

Record page views on your website with Segment API on New Message In Channels from Slack API

Slack + Segment

Try it

Record page views on your website with Segment API on New Message in Channel from Discord Bot API

Discord Bot + Segment

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.

Record page views on your website on Segment

Description:The page method lets you record page views on your website, along with optional extra information about the page being viewed (note requires userId or anonymousId). See the docs [here](https://segment.com/docs/connections/sources/catalog/libraries/server/http-api/#page)

Version:0.2.4

Key:segment-page

View on GitHub

Code#

import segmentApp from "../../segment.app.mjs";

export default {
  key: "segment-page",
  name: "Record page views on your website",
  description: "The page method lets you record page views on your website, along with optional extra information about the page being viewed (note requires userId or anonymousId). See the docs [here](https://segment.com/docs/connections/sources/catalog/libraries/server/http-api/#page)",
  version: "0.2.4",
  type: "action",
  props: {
    segmentApp,
    anonymousId: {
      propDefinition: [
        segmentApp,
        "anonymousId",
      ],
    },
    context: {
      propDefinition: [
        segmentApp,
        "context",
      ],
    },
    integrations: {
      propDefinition: [
        segmentApp,
        "integrations",
      ],
    },
    label: {
      type: "string",
      label: "Page Name",
      description: "Name of the page",
      optional: true,
    },
    properties: {
      type: "object",
      label: "Page Properties",
      description: "Free-form dictionary of properties of the page, like url and referrer",
      optional: true,
    },
    timestamp: {
      propDefinition: [
        segmentApp,
        "timestamp",
      ],
    },
    userId: {
      propDefinition: [
        segmentApp,
        "userId",
      ],
    },
  },
  async run({ $ }) {
    return this.segmentApp.page({
      $,
      data: {
        anonymousId: this.anonymousId,
        context: this.context,
        integrations: this.integrations,
        label: this.name,
        properties: this.properties,
        timestamp: this.timestamp,
        userId: this.userId,
      },
    });
  },
};

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
Segment	`segmentApp`	`app`	This component uses the Segment app.
Anonymous ID	`anonymousId`	`string`	A pseudo-unique substitute for a User ID, for cases when you don't have an absolutely unique identifier. A User ID or an Anonymous ID is required.
Context	`context`	`object`	Dictionary of extra information that provides useful context about a message, but is not directly related to the API call like ip address or locale
Integrations	`integrations`	`object`	Dictionary of destinations to either enable or disable
Page Name	`label`	`string`	Name of the page
Page Properties	`properties`	`object`	Free-form dictionary of properties of the page, like url and referrer
Timestamp	`timestamp`	`string`	Timestamp when the message itself took place, defaulted to the current time by the Segment Tracking API. It is an ISO-8601 date string. For example, `2022-04-08T17:32:11.318Z`
User ID	`userId`	`string`	Unique identifier for the user in your database., A User ID or an Anonymous ID is required.

Authentication#

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

Segment's APIs are accessed programmatically using access tokens, as well as write keys.

Access Token

Create access tokens via the Access Management page in your account: https://app.segment.com/{your-workspace-name}/settings/access-management. See "Get a Token" for more details. Please note, that you must be on a Team or Business plan to create an access token.

Write Key

You will also need to find your write key, which is a unique identifier for your Source. To find a write key, you first need to create a non-Cloud Source such as a website, server, or mobile source. (Cloud-sources do not have write keys, as they use a token or key from your account with that service.) Then, in the Source, go to “Settings’, and then go to “API Keys”. See "Locating Your Write Key" for more details.

About Segment#

Customer data platform

More Ways to Use Segment#

Triggers#

Webhook Destination (Instant) from the Segment API

Send events to a webhook. Requires a Team or Business account.

Try it

Actions#

Associate an identified user with a group with the Segment API

Group lets you associate an identified user with a group (note requires userId or anonymousId). See the docs here

Try it

Associate one identity with another with the Segment API

Alias is how you associate one identity with another. See the docs here

Try it

Identify a user, tie them to their actions and record traits about them with the Segment API

Identify lets you tie a user to their actions and record traits about them. It includes a unique User ID and any optional traits you know about them (note requires userId or anonymousId). See the docs here

Try it

Record whenever a user sees a screen with the Segment API

The screen method let you record whenever a user sees a screen of your mobile app (note requires userId or anonymousId). See the docs here

Try it

Track actions your users perform with the Segment API

Track lets you record the actions your users perform (note requires userId or anonymousId). See the docs here

Try it