Create Project Insight with PostHog API

Pipedream makes it easy to connect APIs for PostHog and 3,000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Project Insight with the PostHog 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 Create Project Insight with the PostHog API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Create Project Insight action
1. Connect your PostHog account
2. Select a Organization ID
3. Select a Project ID
4. Optional- Configure Name
5. Optional- Configure Derived Name
6. Optional- Configure Query
7. Optional- Configure Description
8. Optional- Configure Tags
9. Optional- Configure Favorited
10. Optional- Configure Deleted
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

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.

Create Project Insight on PostHog

Description:Create a new insight in a project. [See the documentation](https://posthog.com/docs/api/insights#post-api-projects-project_id-insights)

Version:0.0.1

Key:posthog-create-project-insight

View on GitHub

Code#

import posthog from "../../posthog.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "posthog-create-project-insight",
  name: "Create Project Insight",
  description: "Create a new insight in a project. [See the documentation](https://posthog.com/docs/api/insights#post-api-projects-project_id-insights)",
  version: "0.0.1",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
    idempotentHint: false,
  },
  type: "action",
  props: {
    posthog,
    organizationId: {
      propDefinition: [
        posthog,
        "organizationId",
      ],
    },
    projectId: {
      propDefinition: [
        posthog,
        "projectId",
        (c) => ({
          organizationId: c.organizationId,
        }),
      ],
    },
    name: {
      type: "string",
      label: "Name",
      description: "Name of the insight",
      optional: true,
    },
    derivedName: {
      type: "string",
      label: "Derived Name",
      description: "Derived name of the insight",
      optional: true,
    },
    query: {
      propDefinition: [
        posthog,
        "query",
      ],
    },
    description: {
      type: "string",
      label: "Description",
      description: "Description of the insight",
      optional: true,
    },
    tags: {
      type: "string[]",
      label: "Tags",
      description: "Tags for the insight",
      optional: true,
    },
    favorited: {
      type: "boolean",
      label: "Favorited",
      description: "Whether the insight is favorited",
      optional: true,
    },
    deleted: {
      type: "boolean",
      label: "Deleted",
      description: "Whether the insight is deleted",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      posthog,
      projectId,
      name,
      derivedName,
      query,
      description,
      tags,
      favorited,
      deleted,
    } = this;

    const insight = await posthog.createInsight({
      $,
      projectId,
      data: {
        name,
        derived_name: derivedName,
        query: utils.parseJson(query),
        description,
        tags: utils.parseJson(tags),
        favorited,
        deleted,
      },
    });

    $.export("$summary", `Successfully created insight${name
      ? ` "${name}"`
      : ""} with ID ${insight.id}`);
    return insight;
  },
};

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
PostHog	`posthog`	`app`	This component uses the PostHog app.
Organization ID	`organizationId`	`string`	Select a value from the drop down menu.
Project ID	`projectId`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	Name of the insight
Derived Name	`derivedName`	`string`	Derived name of the insight
Query	`query`	`object`	Query object defining the insight. Must be a valid PostHog query object with format: `{"kind": "InsightVizNode", "source": {...}}`. Common query types: TrendsQuery: Time-series trend analysis. Example: `{"kind": "InsightVizNode", "source": {"kind": "TrendsQuery", "series": [{"kind": "EventsNode", "event": "pageview", "name": "pageview", "math": "total"}], "trendsFilter": {}}}` FunnelsQuery: Conversion funnel analysis. Example: `{"kind": "InsightVizNode", "source": {"kind": "FunnelsQuery", "series": [{"kind": "EventsNode", "event": "signup_started"}, {"kind": "EventsNode", "event": "signup_completed"}], "funnelsFilter": {}}}` RetentionQuery: User retention analysis PathsQuery: User path exploration LifecycleQuery: User lifecycle tracking See PostHog Query API documentation for complete query specifications.
Description	`description`	`string`	Description of the insight
Tags	`tags`	`string[]`	Tags for the insight
Favorited	`favorited`	`boolean`	Whether the insight is favorited
Deleted	`deleted`	`boolean`	Whether the insight is deleted