Plausible

Retrieve website analytics stats from Plausible.

AnalyticsAPI key16 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (16)
create_custom_property
create_goal
create_shared_link
create_site
delete_custom_property
delete_goal
delete_site
get_site
invite_guest
list_custom_properties
list_goals
list_guests
list_sites
list_teams
remove_guest
update_site
Details

Connect

Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("plausible", "create_custom_property", {
    "site_id": "<site_id>",
    "property": "<property name>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Plausible answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "plausible-create-custom-property",
  name: "Plausible: Create Custom Property",
  description: "Calls Plausible when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("plausible", {
      "action": "create_custom_property",
      "site_id": "<site_id>",
      "property": "<property name>"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/plausible/create_custom_property" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"site_id":"<site_id>","property":"<property name>"}}'

Actions

create_custom_propertyin catalog

Create Custom Property. Create a custom property for a site

Input	Type	Description
`site_id`required	id (picked from your account)	Select a site
`property`required	text	Name of the custom property

create_goalin catalog

Create Goal. Find or create a goal for a site

Input	Type	Description
`site_id`required	id (picked from your account)	Select a site
`goal_type`required	one of "event" \| "page"	Type of goal to create
`event_name`optional	text	Name of the event (required if goal type is Event)
`page_path`optional	text	Page path to track (required if goal type is Page). Supports wildcards.
`display_name`optional	text	Custom display name for the goal in the dashboard

create_shared_linkin catalog

Create Shared Link. Find or create a shared link for a site

Input	Type	Description
`site_id`required	id (picked from your account)	Select a site
`name`required	text	Name of the shared link (e.g., Wordpress)

create_sitein catalog

Create Site. Create a new site in your Plausible account

Input	Type	Description
`domain`required	text	Domain of the site (must be globally unique)
`timezone`optional	text	Timezone name according to IANA database (e.g., Europe/London). Defaults to Etc/UTC
`team_id`optional	id (picked from your account)	Select a team
`track_404_pages`optional	boolean	Enable tracking of 404 error pages
`hash_based_routing`optional	boolean	Enable hash-based routing for single-page applications
`outbound_links`optional	boolean	Track clicks on outbound links
`file_downloads`optional	boolean	Track file downloads
`form_submissions`optional	boolean	Track form submissions

delete_custom_propertyin catalog

Delete Custom Property. Delete a custom property from a site

Input	Type	Description
`site_id`required	id (picked from your account)	Select a site
`property`required	id (picked from your account)	Select a custom property

delete_goalin catalog

Delete Goal. Delete a goal from a site

Input	Type	Description
`site_id`required	id (picked from your account)	Select a site
`goal_id`required	id (picked from your account)	Select a goal

delete_site

Delete Site. Delete a site and all its data from your Plausible account. This action is permanent and may take up to 48 hours to complete.

Input	Type	Description
`site_id`required	id (picked from your account)	Select a site

get_site

Get Site. Get details of a site including tracker script configuration

Input	Type	Description
`site_id`required	id (picked from your account)	Select a site

invite_guest

Invite Guest. Invite a guest to access a site or find an existing invitation

Input	Type	Description
`site_id`required	id (picked from your account)	Select a site
`email`required	text	Guest's email address
`role`required	one of "viewer" \| "editor"	Role to assign to the guest

list_custom_properties

List Custom Properties. Get a list of custom properties for a site

Input	Type	Description
`site_id`required	id (picked from your account)	Select a site

list_goals

List Goals. Get a list of goals for a site

Input	Type	Description
`site_id`required	id (picked from your account)	Select a site

list_guests

List Guests. Get a list of guests for a site

Input	Type	Description
`site_id`required	id (picked from your account)	Select a site

list_sites

List Sites. Get a list of sites your Plausible account can access

No input.

list_teams

List Teams. Get a list of teams your Plausible account can access

No input.

remove_guest

Remove Guest. Remove a guest or invitation from a site

Input	Type	Description
`site_id`required	id (picked from your account)	Select a site
`email`required	id (picked from your account)	Select a guest

update_site

Update Site. Update an existing site in your Plausible account

Input	Type	Description
`site_id`required	id (picked from your account)	Select a site
`new_domain`optional	text	New domain name for the site (leave empty to keep current)
`track_404_pages`optional	boolean	Enable tracking of 404 error pages
`hash_based_routing`optional	boolean	Enable hash-based routing for single-page applications
`outbound_links`optional	boolean	Track clicks on outbound links
`file_downloads`optional	boolean	Track file downloads
`form_submissions`optional	boolean	Track form submissions

Details

Id: plausible
Category: Analytics
Tags: analytics, privacy, open-source, stats
Package: @activepieces/piece-plausible@0.0.5
Tier: Community

Plausible

Retrieve website analytics stats from Plausible.

AnalyticsAPI key16 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (16)
create_custom_property
create_goal
create_shared_link
create_site
delete_custom_property
delete_goal
delete_site
get_site
invite_guest
list_custom_properties
list_goals
list_guests
list_sites
list_teams
remove_guest
update_site
Details

Connect

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("plausible", "create_custom_property", {
    "site_id": "<site_id>",
    "property": "<property name>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Plausible answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "plausible-create-custom-property",
  name: "Plausible: Create Custom Property",
  description: "Calls Plausible when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("plausible", {
      "action": "create_custom_property",
      "site_id": "<site_id>",
      "property": "<property name>"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/plausible/create_custom_property" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"site_id":"<site_id>","property":"<property name>"}}'

Actions

create_custom_propertyin catalog

Create Custom Property. Create a custom property for a site

Input	Type	Description
`site_id`required	id (picked from your account)	Select a site
`property`required	text	Name of the custom property

create_goalin catalog

Create Goal. Find or create a goal for a site

Input	Type	Description
`site_id`required	id (picked from your account)	Select a site
`goal_type`required	one of "event" \| "page"	Type of goal to create
`event_name`optional	text	Name of the event (required if goal type is Event)
`page_path`optional	text	Page path to track (required if goal type is Page). Supports wildcards.
`display_name`optional	text	Custom display name for the goal in the dashboard

create_shared_linkin catalog

Create Shared Link. Find or create a shared link for a site

Input	Type	Description
`site_id`required	id (picked from your account)	Select a site
`name`required	text	Name of the shared link (e.g., Wordpress)

create_sitein catalog

Create Site. Create a new site in your Plausible account

Input	Type	Description
`domain`required	text	Domain of the site (must be globally unique)
`timezone`optional	text	Timezone name according to IANA database (e.g., Europe/London). Defaults to Etc/UTC
`team_id`optional	id (picked from your account)	Select a team
`track_404_pages`optional	boolean	Enable tracking of 404 error pages
`hash_based_routing`optional	boolean	Enable hash-based routing for single-page applications
`outbound_links`optional	boolean	Track clicks on outbound links
`file_downloads`optional	boolean	Track file downloads
`form_submissions`optional	boolean	Track form submissions

delete_custom_propertyin catalog

Delete Custom Property. Delete a custom property from a site

Input	Type	Description
`site_id`required	id (picked from your account)	Select a site
`property`required	id (picked from your account)	Select a custom property

delete_goalin catalog

Delete Goal. Delete a goal from a site

Input	Type	Description
`site_id`required	id (picked from your account)	Select a site
`goal_id`required	id (picked from your account)	Select a goal

delete_site

Delete Site. Delete a site and all its data from your Plausible account. This action is permanent and may take up to 48 hours to complete.

Input	Type	Description
`site_id`required	id (picked from your account)	Select a site

get_site

Get Site. Get details of a site including tracker script configuration

Input	Type	Description
`site_id`required	id (picked from your account)	Select a site

invite_guest

Invite Guest. Invite a guest to access a site or find an existing invitation

Input	Type	Description
`site_id`required	id (picked from your account)	Select a site
`email`required	text	Guest's email address
`role`required	one of "viewer" \| "editor"	Role to assign to the guest

list_custom_properties

List Custom Properties. Get a list of custom properties for a site

Input	Type	Description
`site_id`required	id (picked from your account)	Select a site

list_goals

List Goals. Get a list of goals for a site

Input	Type	Description
`site_id`required	id (picked from your account)	Select a site

list_guests

List Guests. Get a list of guests for a site

Input	Type	Description
`site_id`required	id (picked from your account)	Select a site

list_sites

List Sites. Get a list of sites your Plausible account can access

No input.

list_teams

List Teams. Get a list of teams your Plausible account can access

No input.

remove_guest

Remove Guest. Remove a guest or invitation from a site

Input	Type	Description
`site_id`required	id (picked from your account)	Select a site
`email`required	id (picked from your account)	Select a guest

update_site

Update Site. Update an existing site in your Plausible account

Input	Type	Description
`site_id`required	id (picked from your account)	Select a site
`new_domain`optional	text	New domain name for the site (leave empty to keep current)
`track_404_pages`optional	boolean	Enable tracking of 404 error pages
`hash_based_routing`optional	boolean	Enable hash-based routing for single-page applications
`outbound_links`optional	boolean	Track clicks on outbound links
`file_downloads`optional	boolean	Track file downloads
`form_submissions`optional	boolean	Track form submissions

Details

Id: plausible
Category: Analytics
Tags: analytics, privacy, open-source, stats
Package: @activepieces/piece-plausible@0.0.5
Tier: Community