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.
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
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:
Sign in to your Piwik PRO account.
Click your email address in the top navigation to open the Menu, then go to your Profile.
Select API keys, then click Create a key.
Enter a name for the key and confirm with OK.
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.
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.
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.
Field
Required
Secret
Description
Account URL
Yes
No
Your 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 ID
Yes
Yes
Client ID of a Piwik PRO API key. Create one under Menu > Profile (your email) > API keys > Create a key.
Client Secret
Yes
Yes
Client secret of the same Piwik PRO API key. It is shown only once, when the key is created.
After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.
Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.
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.
Enter the client ID of your Piwik PRO API key in the Client ID field.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.