Skip to main content

Piwik

Piwik PRO is a privacy-focused analytics and customer data platform that lets organizations collect, analyze, and act on web, app, and product analytics data while retaining full data ownership. The Piwik PRO connector reads analytics reports and raw sessions and events, apps and meta sites, users, user groups and permissions, tracker settings, Tag Manager tags, triggers and variables, Audience Manager audiences and profiles, and audit logs, and can create, update, and delete most of these objects. Nexla connects with a Piwik PRO API key (client ID and client secret) and renews the access token automatically.

Piwik icon

Power end-to-end data operations for your Piwik API with Nexla. Our bi-directional Piwik connector is purpose-built for Piwik, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Piwik or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Piwik workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites​

Nexla connects to Piwik PRO with an API key that you create in your Piwik PRO profile. An API key consists of a client ID and a client secret. Nexla exchanges them for an access token at your account's authentication endpoint (OAuth 2.0 client credentials), so you do not need to generate tokens yourself.

To create a Piwik PRO API key:

  1. Sign in to your Piwik PRO account.

  2. Click your email address in the top navigation to open the Menu, then go to your Profile.

  3. Select API keys, then click Create a key.

  4. Enter a name for the key and confirm with OK.

  5. Copy both the Client ID and the Client secret immediately. The client secret is shown only once and cannot be retrieved after you close the window.

  6. Note your Piwik PRO account URL: the address you use to sign in, for example https://example.piwik.pro, without a trailing slash.

Piwik PRO access tokens expire 30 minutes after they are issued. Nexla requests a new token with the client ID and client secret whenever the current one expires, so the credential keeps working without manual updates. Keep your client secret confidential; if it is compromised, delete the API key in your Piwik PRO profile and create a new one. For details, see Piwik PRO's authentication guide and API reference.

Authenticate​

Credentials required​

Piwik PRO API key (client ID + client secret). Nexla exchanges them at <account URL>/auth/token (OAuth2 client credentials) for a 30-minute bearer token and renews it automatically.

FieldRequiredSecretDescription
Account URLYesNoYour Piwik PRO account URL, e.g. https://example.piwik.pro (no trailing slash). It is the address you use to log in to Piwik PRO.
Client IDYesYesClient ID of a Piwik PRO API key. Create one under Menu > Profile (your email) > API keys > Create a key.
Client SecretYesYesClient secret of the same Piwik PRO API key. It is shown only once, when the key is created.

Create a credential in Nexla​

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Enter your Piwik PRO account URL in the Account URL field, for example https://example.piwik.pro, without a trailing slash. Nexla uses it as the base URL for the token request and for every endpoint template.

  4. Enter the client ID of your Piwik PRO API key in the Client ID field.

  5. Enter the client secret of the same API key in the Client Secret field.

    The client ID and client secret are stored as secrets, and the client secret is masked when you enter it. Nexla tests the credential by requesting an access token from /auth/token on your account URL and listing one app from your account.

  6. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source​

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Piwik connector tile, then select the credential that will be used to connect to the Piwik PRO instance, and click Next; or, create a new Piwik credential for use in this flow.

Endpoint templates​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Piwik PRO endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below, grouped by the part of Piwik PRO they read.

Most templates need the ID of an app (site) or meta site. App and meta site IDs are UUIDs; use List Apps, List Meta-Sites, or List Apps and Meta Sites to find them, or open Administration > Sites & apps in Piwik PRO. List templates page through results with offset-based pagination and fetch every page.

Users and user groups​

Get Current User

Retrieves the user the API key belongs to (email, role, language).

Get User

Retrieves one user (email, role, language) by ID.

Get User Group

Retrieves one user group by ID.

List User Group Members

Lists the users in one user group.

  • User Group ID (required): Piwik PRO user group ID (UUID), from List User-Groups.
  • Nexla follows the pagination and fetches every page.
  • Reference: Piwik PRO API documentation

List User-Groups

Lists the user groups in the organization.

List Users

Lists the users of the organization.

List Users Not in User Group

Lists the users who are not in one user group.

  • User Group ID (required): Piwik PRO user group ID (UUID), from List User-Groups.
  • Nexla follows the pagination and fetches every page.
  • Reference: Piwik PRO API documentation

Apps and meta sites​

Get App Details

Retrieves one app's full settings (URLs, timezone, currency, privacy, e-commerce) by ID.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Reference: Piwik PRO API documentation

Get Meta Site

Retrieves one meta site (name, currency, timezone) by ID.

Get Meta Site Integrity

Checks whether the apps in a meta site share one currency and timezone.

List Apps

Lists the apps (websites and mobile apps) in the account.

List Apps and Meta Sites

Lists apps and meta sites together in one list.

List Apps Excluded From Meta Site

Lists the apps that are not in one meta site.

  • Meta Site ID (required): Piwik PRO meta site ID (UUID), from List Meta-Sites.
  • Nexla follows the pagination and fetches every page.
  • Reference: Piwik PRO API documentation

List Meta Site Apps

Lists the apps included in one meta site.

  • Meta Site ID (required): Piwik PRO meta site ID (UUID), from List Meta-Sites.
  • Nexla follows the pagination and fetches every page.
  • Reference: Piwik PRO API documentation

List Meta-Sites

Lists the meta sites (roll-ups of several apps).

Permissions and modules​

Get Entity Actions

Retrieves the actions the API key's user may perform on one app or meta site.

List App User Group Permissions

Lists user groups and their permission on one app.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Nexla follows the pagination and fetches every page.
  • Reference: Piwik PRO API documentation

List App User Permissions

Lists users (not owners) and their explicit or inherited permission on one app.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Nexla follows the pagination and fetches every page.
  • Reference: Piwik PRO API documentation

List Apps With Action

Lists the apps on which the API key's user has the given permission action.

List Global Actions

Lists the actions the API key's user may perform without an app or meta site context (e.g. add apps).

List Meta Site User Group Permissions

Lists user groups and their permission on one meta site.

  • Meta Site ID (required): Piwik PRO meta site ID (UUID), from List Meta-Sites.
  • Nexla follows the pagination and fetches every page.
  • Reference: Piwik PRO API documentation

List Meta Site User Permissions

Lists users (not owners) and their explicit or inherited permission on one meta site.

  • Meta Site ID (required): Piwik PRO meta site ID (UUID), from List Meta-Sites.
  • Nexla follows the pagination and fetches every page.
  • Reference: Piwik PRO API documentation

List Meta Sites With Action

Lists the meta sites on which the API key's user has the given permission action.

List Modules

Lists the Piwik PRO modules (Analytics, Tag Manager, Consent Manager, ...) enabled for the account.

List User Module Access

Lists the Piwik PRO modules one user can access.

List Users With Action

Lists the users on whom the API key's user may perform the given action.

Tracker settings​

Get App Tracker Settings

Retrieves the tracker settings of one app (falls back to global values where not overridden).

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Reference: Piwik PRO API documentation

Get App Tracker Settings by URL

Retrieves the tracker settings of the app that owns a given URL.

Get Global Tracker Settings

Retrieves the account-wide tracker settings (IP anonymization, excluded IPs/user agents, campaign and site-search params).

Analytics​

Run Analytics Query, List Sessions, and List Events take a date range (YYYY-MM-DD, in the app's time zone) and a JSON array of columns, and send them in a POST request body. The analytics settings templates (goals, custom dimensions, annotations) take the app or meta site ID as App or Meta Site ID.

Get Custom Dimension

Retrieves one custom dimension by ID.

  • ID (required): The custom dimension ID (UUID). Use List Custom Dimensions to find it.
  • App or Meta Site ID (required): The ID (UUID) of the app or meta site. Use List Apps or List Meta-Sites to find it.
  • Reference: Piwik PRO API documentation

Get Custom Dimension Slots

Retrieves how many event, session and product custom dimension slots one app has left.

  • App or Meta Site ID (required): The ID (UUID) of the app or meta site. Use List Apps or List Meta-Sites to find it.
  • Reference: Piwik PRO API documentation

Get Goal

Retrieves one conversion goal by ID.

  • ID (required): The goal ID (UUID). Use List Goals to find it.
  • App or Meta Site ID (required): The ID (UUID) of the app or meta site. Use List Apps or List Meta-Sites to find it.
  • Reference: Piwik PRO API documentation

Get Product Custom Dimension

Retrieves one product custom dimension by ID.

  • ID (required): The product custom dimension ID (UUID). Use List Product Custom Dimensions to find it.
  • App or Meta Site ID (required): The ID (UUID) of the app or meta site. Use List Apps or List Meta-Sites to find it.
  • Reference: Piwik PRO API documentation

Get User Annotation

Retrieves one user annotation by ID.

  • ID (required): The user annotation ID (UUID). Use List User Annotations to find it.
  • App or Meta Site ID (required): The ID (UUID) of the app or meta site. Use List Apps or List Meta-Sites to find it.
  • Reference: Piwik PRO API documentation

List Custom Dimensions

Lists the session and event custom dimensions of one app.

  • App or Meta Site ID (required): The ID (UUID) of the app or meta site. Use List Apps or List Meta-Sites to find it.
  • Nexla follows the pagination and fetches every page.
  • Reference: Piwik PRO API documentation

List Events

Exports raw event records of one app over a date range.

  • App or Meta Site ID (required): The ID (UUID) of the app or meta site. Use List Apps or List Meta-Sites to find it.
  • Date From (required): Start date, inclusive, YYYY-MM-DD (website timezone).
  • Date To (required): End date, inclusive, YYYY-MM-DD (website timezone).
  • Columns (JSON) (required): A JSON array of column definitions, each with a column_id (for example source_medium or sessions). See Piwik PRO's metrics and dimensions for the column IDs. Default: [{"column_id":"event_type"},{"column_id":"event_url"}].
  • Nexla follows the pagination and fetches every page.
  • This template sends a POST request to run the query. It only reads data.
  • Reference: Piwik PRO API documentation

List Goals

Lists the conversion goals of one app.

  • App or Meta Site ID (required): The ID (UUID) of the app or meta site. Use List Apps or List Meta-Sites to find it.
  • Nexla follows the pagination and fetches every page.
  • Reference: Piwik PRO API documentation

List Product Custom Dimensions

Lists the product custom dimensions of one app.

  • App or Meta Site ID (required): The ID (UUID) of the app or meta site. Use List Apps or List Meta-Sites to find it.
  • Reference: Piwik PRO API documentation

List Sessions

Exports raw session records of one app over a date range.

  • App or Meta Site ID (required): The ID (UUID) of the app or meta site. Use List Apps or List Meta-Sites to find it.
  • Date From (required): Start date, inclusive, YYYY-MM-DD (website timezone).
  • Date To (required): End date, inclusive, YYYY-MM-DD (website timezone).
  • Columns (JSON) (required): A JSON array of column definitions, each with a column_id (for example source_medium or sessions). See Piwik PRO's metrics and dimensions for the column IDs. Default: [{"column_id":"source_medium"},{"column_id":"session_total_page_views"}].
  • Nexla follows the pagination and fetches every page.
  • This template sends a POST request to run the query. It only reads data.
  • Reference: Piwik PRO API documentation

List System Annotations

Lists Piwik PRO system annotations (product changes, incidents) for one app.

  • App or Meta Site ID (required): The ID (UUID) of the app or meta site. Use List Apps or List Meta-Sites to find it.
  • Nexla follows the pagination and fetches every page.
  • Reference: Piwik PRO API documentation

List User Annotations

Lists the user annotations (dated notes) of one app or meta site.

  • App or Meta Site ID (required): The ID (UUID) of the app or meta site. Use List Apps or List Meta-Sites to find it.
  • Nexla follows the pagination and fetches every page.
  • Reference: Piwik PRO API documentation

Run Analytics Query

Runs an aggregated analytics report (dimensions + metrics) for one app or meta site over a date range.

  • App or Meta Site ID (required): The ID (UUID) of the app or meta site. Use List Apps or List Meta-Sites to find it.
  • Date From (required): Start date, inclusive, YYYY-MM-DD (website timezone).
  • Date To (required): End date, inclusive, YYYY-MM-DD (website timezone).
  • Columns (JSON) (required): A JSON array of column definitions, each with a column_id (for example source_medium or sessions). See Piwik PRO's metrics and dimensions for the column IDs. Default: [{"column_id":"source_medium"},{"column_id":"sessions"}].
  • Nexla follows the pagination and fetches every page.
  • This template sends a POST request to run the query. It only reads data.
  • Reference: Piwik PRO API documentation

Tag Manager​

Tag Manager and container settings templates send the JSON:API headers Content-Type: application/vnd.api+json and Accept: application/vnd.api+json that these Piwik PRO endpoints use.

Get App Installation Code

Retrieves the tracking-code snippet to install for one app.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Reference: Piwik PRO API documentation

Get Draft Version

Retrieves the current draft Tag Manager version of one app (has_changes tells if unpublished edits exist).

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Reference: Piwik PRO API documentation

Get Operation

Retrieves the status of an asynchronous Tag Manager operation (copy, publish, import).

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Operation ID (required): ID of an asynchronous Tag Manager operation (returned by copy/publish/import calls).
  • Reference: Piwik PRO API documentation

Get Published Version

Retrieves the live (published) Tag Manager version of one app.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Reference: Piwik PRO API documentation

Get Tag

Retrieves one Tag Manager tag (template, triggers, consent type) by ID.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Tag ID (required): Tag Manager tag ID (UUID), from List Tags.
  • Reference: Piwik PRO API documentation

Get Trigger

Retrieves one Tag Manager trigger by ID.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Trigger ID (required): Tag Manager trigger ID (UUID), from List Triggers.
  • Reference: Piwik PRO API documentation

Get Variable

Retrieves one Tag Manager variable by ID.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Variable ID (required): Tag Manager variable ID (UUID), from List Variables.
  • Reference: Piwik PRO API documentation

Get Version

Retrieves one Tag Manager container version by ID.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Version ID (required): Tag Manager version ID (UUID), from List Versions.
  • Reference: Piwik PRO API documentation

Get Version Overview

Retrieves the tags, triggers and variables contained in one Tag Manager version.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Version ID (required): Tag Manager version ID (UUID), from List Versions.
  • Reference: Piwik PRO API documentation

List App Container Settings

Lists the Tag Manager container settings of one app.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Reference: Piwik PRO API documentation

List App Default Container Settings

Lists the default Tag Manager container settings that apply to one app.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Reference: Piwik PRO API documentation

List Organization Container Settings

Lists the organization-wide Tag Manager container settings.

  • Organization (required): Your Piwik PRO organization name (the account subdomain, e.g. example for example.piwik.pro).
  • Reference: Piwik PRO API documentation

List Tag Triggers

Lists the triggers that fire one tag.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Tag ID (required): Tag Manager tag ID (UUID), from List Tags.
  • Nexla follows the pagination and fetches every page.
  • Reference: Piwik PRO API documentation

List Tag Variables

Lists the variables one tag uses.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Tag ID (required): Tag Manager tag ID (UUID), from List Tags.
  • Nexla follows the pagination and fetches every page.
  • Reference: Piwik PRO API documentation

List Tags

Lists the Tag Manager tags of one app.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Nexla follows the pagination and fetches every page.
  • Reference: Piwik PRO API documentation

List Trigger Tags

Lists the tags one trigger fires.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Trigger ID (required): Tag Manager trigger ID (UUID), from List Triggers.
  • Nexla follows the pagination and fetches every page.
  • Reference: Piwik PRO API documentation

List Triggers

Lists the Tag Manager triggers of one app.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Nexla follows the pagination and fetches every page.
  • Reference: Piwik PRO API documentation

List Variables

Lists the Tag Manager variables of one app.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Nexla follows the pagination and fetches every page.
  • Reference: Piwik PRO API documentation

List Version Changes

Lists the changes recorded in one Tag Manager version.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Version ID (required): Tag Manager version ID (UUID), from List Versions.
  • Nexla follows the pagination and fetches every page.
  • Reference: Piwik PRO API documentation

List Versions

Lists the Tag Manager container versions (draft, published, snapshots) of one app.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Nexla follows the pagination and fetches every page.
  • Reference: Piwik PRO API documentation

Audience Manager​

Get Activation

Retrieves one Audience Manager activation by ID.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • ID (required): The activation ID (UUID). Use List Activations to find it.
  • Reference: Piwik PRO API documentation

Get Activation Usage

Retrieves how many activations the account uses.

Get Audience

Retrieves one Audience Manager audience (definition, membership duration) by ID.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • ID (required): The audience ID (UUID). Use List Audiences to find it.
  • Reference: Piwik PRO API documentation

Get Profile

Retrieves one Audience Manager profile (attributes, audiences) by ID, cookie ID or user ID.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Identifier Type (required): Which profile identifier to look up by. Options: id (default), cookie_id, user_id.
  • Identifier Value (required): Value of the profile identifier.
  • Reference: Piwik PRO API documentation

List Activation Logs

Lists the last 30 days of logs of one activation, newest first.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Activation ID (required): Audience Manager activation ID (UUID).
  • Nexla follows the pagination and fetches every page.
  • Reference: Piwik PRO API documentation

List Activations

Lists the Audience Manager activations (audience exports to ad platforms) of one app.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Reference: Piwik PRO API documentation

List Audience Profiles

Lists the profiles that belong to one audience version.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Audience ID (required): Audience Manager audience ID (UUID), from List Audiences.
  • Audience Version (required): Audience version number (the version field of the audience). Default: 1.
  • Nexla follows the pagination and fetches every page.
  • Reference: Piwik PRO API documentation

List Audiences

Lists the Audience Manager audiences of one app.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Reference: Piwik PRO API documentation

List Profile Attributes

Lists the profile attributes (built-in and custom) available in one app.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Reference: Piwik PRO API documentation

List Webhook Imports

Lists the Audience Manager webhook imports of one app.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Reference: Piwik PRO API documentation

Audit log​

List Audit-Log Entries

Lists Audit Log entries (who changed what, when), newest first.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration​

Piwik data sources can also be manually configured to ingest data from any valid Piwik PRO API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Piwik PRO endpoint URLs start with your account URL, for example https://example.piwik.pro/api/apps/v2. The credential adds the Authorization: Bearer header with a current access token to each request. Tag Manager and container settings endpoints use the JSON:API media type, so add the Accept: application/vnd.api+json header for them. See the Piwik PRO API reference for the available endpoints.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Piwik data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination​

Click the + icon on the Nexset that will be sent to the Piwik destination, and select the Send to Destination option from the menu. Select the Piwik connector from the list of available destination connectors, then select the credential that will be used to connect to the Piwik PRO instance, and click Next; or, create a new Piwik credential for use in this flow.

Endpoint templates​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Piwik PRO endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Each record in the Nexset is sent as the body of one request, one record at a time. Most Piwik PRO administration endpoints take a JSON:API document (application/vnd.api+json), in which the object goes under data, with its type and, for updates, its id, and the fields under data.attributes; Audience Manager endpoints take plain JSON. ID settings, such as App ID or User ID, are fixed on the destination and apply to every record it sends. Read each template's Side effect note before you activate the destination: several templates are irreversible or affect the whole account.

Users and user groups​

Add Users to User Group

Adds users to a user group.

  • User Group ID (required): Piwik PRO user group ID (UUID), from List User-Groups.
  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is ppms/user. See the reference below for the attributes.
  • Side effect: They inherit the group's permissions.
  • Reference: Piwik PRO API documentation

Change User Role

Changes a user's organization role.

  • User ID (required): Piwik PRO user ID (UUID), from List Users.
  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is ppms/user. See the reference below for the attributes.
  • Side effect: Grants or removes owner rights.
  • Reference: Piwik PRO API documentation

Create User

Creates a user in the organization.

  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is ppms/user. See the reference below for the attributes.
  • Side effect: Piwik PRO emails the new user an activation link.
  • Reference: Piwik PRO API documentation

Create User Group

Adds a user group to the organization.

  • Each record is sent as a JSON:API-shaped document whose data.type is ppms/user-group, with the content type application/json. See the reference below for the attributes.
  • Side effect: Creates a group that can be granted permissions.
  • Reference: Piwik PRO API documentation

Delete User

Deletes a user from the organization.

  • User ID (required): Piwik PRO user ID (UUID), from List Users.
  • Piwik PRO documents no request body for this call, so send an empty record ({}); each record performs the call once.
  • Side effect: Irreversible; the user loses access.
  • Reference: Piwik PRO API documentation

Delete User Group

Deletes a user group.

  • User Group ID (required): Piwik PRO user group ID (UUID), from List User-Groups.
  • Piwik PRO documents no request body for this call, so send an empty record ({}); each record performs the call once.
  • Side effect: Members lose permissions granted via the group.
  • Reference: Piwik PRO API documentation

Invite User

Invites a user by email.

  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is ppms/user. See the reference below for the attributes.
  • Side effect: Piwik PRO emails an invitation.
  • Reference: Piwik PRO API documentation

Update User

Edits a user's details (e.g. language).

  • User ID (required): Piwik PRO user ID (UUID), from List Users.
  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is ppms/user. See the reference below for the attributes.
  • Side effect: Changes the user's account.
  • Reference: Piwik PRO API documentation

Update User Group

Renames a user group.

  • User Group ID (required): Piwik PRO user group ID (UUID), from List User-Groups.
  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is ppms/user-group. See the reference below for the attributes.
  • Side effect: Changes the group for all its members.
  • Reference: Piwik PRO API documentation

Apps and meta sites​

Add Apps to Meta Site

Adds apps to a meta site.

  • Meta Site ID (required): Piwik PRO meta site ID (UUID), from List Meta-Sites.
  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is ppms/app. See the reference below for the attributes.
  • Side effect: Their data starts rolling up into the meta site.
  • Reference: Piwik PRO API documentation

Create App

Adds a website or mobile app to Piwik PRO.

  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is ppms/app. See the reference below for the attributes.
  • Side effect: A new app starts collecting data once its tracking code is installed.
  • Reference: Piwik PRO API documentation

Create Meta Site

Adds a meta site (a roll-up of several apps).

  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is ppms/meta-site. See the reference below for the attributes.
  • Side effect: Creates a reporting object visible to users with access.
  • Reference: Piwik PRO API documentation

Delete App

Deletes an app.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Piwik PRO documents no request body for this call, so send an empty record ({}); each record performs the call once.
  • Side effect: Irreversible; the app's collected data and reports are removed.
  • Reference: Piwik PRO API documentation

Delete Meta Site

Deletes a meta site.

  • Meta Site ID (required): Piwik PRO meta site ID (UUID), from List Meta-Sites.
  • Piwik PRO documents no request body for this call, so send an empty record ({}); each record performs the call once.
  • Side effect: Irreversible; the apps themselves are kept.
  • Reference: Piwik PRO API documentation

Update App

Edits an app's settings (name, URLs, timezone, privacy).

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is ppms/app. See the reference below for the attributes.
  • Side effect: Changes tracking and reporting for that app from now on.
  • Reference: Piwik PRO API documentation

Update Meta Site

Edits a meta site's name, currency or timezone.

  • Meta Site ID (required): Piwik PRO meta site ID (UUID), from List Meta-Sites.
  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is ppms/meta-site. See the reference below for the attributes.
  • Side effect: Changes its reports.
  • Reference: Piwik PRO API documentation

Permissions and modules​

Set App User Group Permission

Sets a user group's permission on an app.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • User Group ID (required): Piwik PRO user group ID (UUID), from List User-Groups.
  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is app/permission/user-group. See the reference below for the attributes.
  • Side effect: Changes access for all members.
  • Reference: Piwik PRO API documentation

Set App User Permission

Sets a user's permission (view/edit/publish/manage) on an app.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • User ID (required): Piwik PRO user ID (UUID), from List Users.
  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is app/permission/user. See the reference below for the attributes.
  • Side effect: Changes access.
  • Reference: Piwik PRO API documentation

Set Meta Site User Group Permission

Sets a user group's permission on a meta site.

  • Meta Site ID (required): Piwik PRO meta site ID (UUID), from List Meta-Sites.
  • User Group ID (required): Piwik PRO user group ID (UUID), from List User-Groups.
  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is meta-site/permission/user-group. See the reference below for the attributes.
  • Side effect: Changes access for all members.
  • Reference: Piwik PRO API documentation

Set Meta Site User Permission

Sets a user's permission on a meta site.

  • Meta Site ID (required): Piwik PRO meta site ID (UUID), from List Meta-Sites.
  • User ID (required): Piwik PRO user ID (UUID), from List Users.
  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is meta-site/permission/user. See the reference below for the attributes.
  • Side effect: Changes access.
  • Reference: Piwik PRO API documentation

Set User Module Access

Sets which Piwik PRO modules a user can access.

  • User ID (required): Piwik PRO user ID (UUID), from List Users.
  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is module/access. See the reference below for the attributes.
  • Side effect: Changes access.
  • Reference: Piwik PRO API documentation

Tracker settings​

Update App Tracker Settings

Changes one app's tracker settings.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is tracker/settings/app. See the reference below for the attributes.
  • Side effect: Changes how new data is collected.
  • Reference: Piwik PRO API documentation

Update Global Tracker Settings

Changes the account-wide tracker settings.

  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is tracker/settings/app/global. See the reference below for the attributes.
  • Side effect: Affects data collection for every app.
  • Reference: Piwik PRO API documentation

Analytics​

Create Custom Dimension

Creates a session or event custom dimension.

  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is CustomDimension. See the reference below for the attributes.
  • Side effect: Uses one of the app's limited slots.
  • Reference: Piwik PRO API documentation

Create Goal

Creates a conversion goal for an app.

  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is Goal. See the reference below for the attributes.
  • Side effect: New conversions are tracked from now on.
  • Reference: Piwik PRO API documentation

Create Product Custom Dimension

Creates a product custom dimension.

  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is ProductCustomDimension. See the reference below for the attributes.
  • Side effect: Uses one of the app's limited slots.
  • Reference: Piwik PRO API documentation

Create User Annotation

Creates a user annotation (a dated note on analytics charts) for one app.

  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is UserAnnotation. See the reference below for the attributes.
  • Side effect: The note is visible to all users of the app.
  • Reference: Piwik PRO API documentation

Delete Goal

Deletes a conversion goal.

  • ID (required): The goal ID (UUID). Use List Goals to find it.
  • App or Meta Site ID (required): The ID (UUID) of the app or meta site. Use List Apps or List Meta-Sites to find it.
  • Piwik PRO documents no request body for this call, so send an empty record ({}); each record performs the call once.
  • Side effect: Irreversible; it stops being tracked.
  • Reference: Piwik PRO API documentation

Delete User Annotation

Deletes a user annotation.

  • ID (required): The user annotation ID (UUID). Use List User Annotations to find it.
  • App or Meta Site ID (required): The ID (UUID) of the app or meta site. Use List Apps or List Meta-Sites to find it.
  • Piwik PRO documents no request body for this call, so send an empty record ({}); each record performs the call once.
  • Side effect: Irreversible.
  • Reference: Piwik PRO API documentation

Update Custom Dimension

Replaces a custom dimension's definition.

  • ID (required): The custom dimension ID (UUID). Use List Custom Dimensions to find it.
  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is CustomDimension. See the reference below for the attributes.
  • Side effect: Changes collected data.
  • Reference: Piwik PRO API documentation

Update Goal

Replaces a goal's definition.

  • ID (required): The goal ID (UUID). Use List Goals to find it.
  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is Goal. See the reference below for the attributes.
  • Side effect: Changes how conversions are counted.
  • Reference: Piwik PRO API documentation

Update Product Custom Dimension

Replaces a product custom dimension's definition.

  • ID (required): The product custom dimension ID (UUID). Use List Product Custom Dimensions to find it.
  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is ProductCustomDimension. See the reference below for the attributes.
  • Side effect: Changes collected data.
  • Reference: Piwik PRO API documentation

Update User Annotation

Edits a user annotation's date or text.

  • ID (required): The user annotation ID (UUID). Use List User Annotations to find it.
  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is UserAnnotation. See the reference below for the attributes.
  • Side effect: Changes a shared chart note.
  • Reference: Piwik PRO API documentation

Tag Manager​

Tag Manager templates send records as JSON:API documents with the Accept: application/vnd.api+json header. Tag, trigger, and variable changes are made in the app's draft version and reach your site only when the draft is published, either with Publish Draft Version or in Piwik PRO.

Create Tag

Creates a Tag Manager tag in the app's draft.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is tag. See the reference below for the attributes.
  • Side effect: Goes live on the next publish.
  • Reference: Piwik PRO API documentation

Create Trigger

Creates a Tag Manager trigger in the draft.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is trigger. See the reference below for the attributes.
  • Side effect: Goes live on the next publish.
  • Reference: Piwik PRO API documentation

Create Variable

Creates a Tag Manager variable in the draft.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is variable. See the reference below for the attributes.
  • Side effect: Goes live on the next publish.
  • Reference: Piwik PRO API documentation

Delete Tag

Deletes a Tag Manager tag from the draft.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Tag ID (required): Tag Manager tag ID (UUID), from List Tags.
  • Piwik PRO documents no request body for this call, so send an empty record ({}); each record performs the call once.
  • Side effect: Removed from the site on the next publish.
  • Reference: Piwik PRO API documentation

Delete Trigger

Deletes a Tag Manager trigger from the draft.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Trigger ID (required): Tag Manager trigger ID (UUID), from List Triggers.
  • Piwik PRO documents no request body for this call, so send an empty record ({}); each record performs the call once.
  • Side effect: Tags using it stop firing after the next publish.
  • Reference: Piwik PRO API documentation

Delete Variable

Deletes a Tag Manager variable from the draft.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Variable ID (required): Tag Manager variable ID (UUID), from List Variables.
  • Piwik PRO documents no request body for this call, so send an empty record ({}); each record performs the call once.
  • Side effect: Removed on the next publish.
  • Reference: Piwik PRO API documentation

Publish Draft Version

Publishes the app's Tag Manager draft.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Piwik PRO documents no request body for this call, so send an empty record ({}); each record performs the call once.
  • Side effect: Every pending tag/trigger/variable change goes live on the site.
  • Reference: Piwik PRO API documentation

Update App Container Settings

Changes an app's Tag Manager container settings.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is container/app/setting. See the reference below for the attributes.
  • Side effect: Changes what the container loads.
  • Reference: Piwik PRO API documentation

Update Tag

Edits a Tag Manager tag in the draft.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Tag ID (required): Tag Manager tag ID (UUID), from List Tags.
  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is tag. See the reference below for the attributes.
  • Side effect: Goes live on the next publish.
  • Reference: Piwik PRO API documentation

Update Trigger

Edits a Tag Manager trigger in the draft.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Trigger ID (required): Tag Manager trigger ID (UUID), from List Triggers.
  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is trigger. See the reference below for the attributes.
  • Side effect: Goes live on the next publish.
  • Reference: Piwik PRO API documentation

Update Variable

Edits a Tag Manager variable in the draft.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Variable ID (required): Tag Manager variable ID (UUID), from List Variables.
  • Each record is sent as a JSON:API document (application/vnd.api+json) whose data.type is variable. See the reference below for the attributes.
  • Side effect: Goes live on the next publish.
  • Reference: Piwik PRO API documentation

Audience Manager​

Audience Manager templates send plain JSON records (application/json). Delete Profile permanently erases a profile, so use it only for erasure requests.

Create Audience

Creates an Audience Manager audience.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Each record is sent as the JSON request body (application/json). See the reference below for the fields.
  • Side effect: Profiles start joining it.
  • Reference: Piwik PRO API documentation

Create Custom Profile Attribute

Creates a custom profile attribute.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Each record is sent as the JSON request body (application/json). See the reference below for the fields.
  • Side effect: Profiles start collecting it.
  • Reference: Piwik PRO API documentation

Delete Audience

Deletes an audience.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • ID (required): The audience ID (UUID). Use List Audiences to find it.
  • Piwik PRO documents no request body for this call, so send an empty record ({}); each record performs the call once.
  • Side effect: Irreversible; activations using it stop.
  • Reference: Piwik PRO API documentation

Delete Profile

Deletes one Audience Manager profile.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Identifier Type (required): Which profile identifier to look up by. Options: id (default), cookie_id, user_id.
  • Identifier Value (required): Value of the profile identifier.
  • Piwik PRO documents no request body for this call, so send an empty record ({}); each record performs the call once.
  • Side effect: Irreversible (GDPR erasure).
  • Reference: Piwik PRO API documentation

Update Audience

Replaces an audience's definition.

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • ID (required): The audience ID (UUID). Use List Audiences to find it.
  • Each record is sent as the JSON request body (application/json). See the reference below for the fields.
  • Side effect: Membership is recalculated.
  • Reference: Piwik PRO API documentation

Update Profile Attributes

Creates or updates attributes of one profile (by cookie or user ID).

  • App ID (required): Piwik PRO app (site) ID, a UUID. Find it under Administration > Sites & apps, or from List Apps.
  • Each record is sent as the JSON request body (application/json). See the reference below for the fields.
  • Side effect: Changes the stored profile.
  • Reference: Piwik PRO API documentation

Manual configuration​

Piwik destinations can also be manually configured to send data to any valid Piwik PRO API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Piwik PRO endpoint URLs start with your account URL. Most administration endpoints expect a JSON:API request body with the content type application/vnd.api+json; check each operation in the Piwik PRO API reference for its content type and fields.

Save & activate​

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Piwik endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Piwik endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.