Jump to Content
Developers | Piwik PRO
HomeDocsWeb APIChangelog
Log InDevelopers | Piwik PRO
Web API
Log In
HomeDocsWeb APIChangelog

Getting started

  • Authentication
  • Make a first API call
  • Rate limits

Resources

  • API call definition
  • Metrics & dimensions
    • Piwik PRO
    • Google Ads
    • Google Search Console
    • SharePoint
    • Exporter
  • Profile attributes
  • Tag Manager
    • Tags
    • Built-in variables
    • Asynchronous operations

Web API

  • Access Control
    • Entity actionsget
    • Apps with granted actionget
    • Meta sites with granted actionget
    • Users with granted actionget
    • Global actionsget
    • Users permissions for a given appget
    • User groups permissions for a given appget
    • Users permissions for a given meta siteget
    • User groups permissions for a given meta siteget
    • Set user permission for a given apppost
    • Set user group permission for a given apppost
    • Set user permission for a given meta sitepost
    • Set user group permission for a given meta sitepost
    • Permission setpost
    • Permissionsget
  • Analytics
    • Execute querypost
    • Execute Real-time querypost
    • Fetch sessionspost
    • Fetch eventspost
    • Fetch Real-time eventspost
    • Create goalpost
    • List goalsget
    • Get goalget
    • Update goalput
    • Delete goaldelete
    • Create custom dimensionpost
    • List custom dimensionsget
    • Get custom dimensionget
    • Update custom dimensionput
    • Get custom dimension slotsget
    • Create product custom dimensionpost
    • List product custom dimensionsget
    • Get product custom dimensionget
    • Update product custom dimensionput
    • Create user annotationpost
    • List user annotationsget
    • Get user annotationget
    • Update user annotationpatch
    • Delete user annotationdelete
    • List System Annotationsget
  • Apps
    • Apps listget
    • App addpost
    • App detailsget
    • App deletedelete
    • App editpatch
    • App permissionsget
    • Apps permission for user groupget
  • Audit Log
    • Entry listget
  • Customer Data Platform
    • List activationsget
    • Create activationpost
    • Fetch activationget
    • Update activationput
    • Delete activationdelete
    • Activate activationpost
    • List attributesget
    • Create custom attributepost
    • Create custom attribute bulkpost
    • Update custom attributeput
    • Create audiencepost
    • List audiencesget
    • Fetch audienceget
    • Update audienceput
    • Delete audiencedelete
    • List enum variantsget
    • Fetch customersget
    • Fetch user listsget
    • Fetch conversion actionsget
    • Fetch last activation logsget
    • Fetch activation logsget
    • Fetch activation statisticsget
    • Fetch details of activation logget
    • Count profiles in audienceget
    • List profiles belonging to given audience.get
    • List profiles belonging to given audienceget
    • Fetch last webhook import requestsget
    • Fetch webhook import requestsget
    • Fetch webhook import requests statisticsget
    • Fetch activation usage statisticsget
    • Fetch audiences the profile belongs toget
    • Get profile by identifierget
    • Create or update profile attributespost
    • Data webhook import GET requestget
    • Data webhook import POST requestpost
    • Data webhook import PUT requestput
    • List webhook importsget
    • Create webhook importpost
    • Fetch webhook importget
    • Update webhook importput
    • Activate webhook importpost
    • Test webhookget
  • Container Settings
    • Get App's installation codeget
    • Get organization's opt-out codeget
    • Get App's container settingsget
    • Modify App's container settingspatch
    • Get the App's container settingget
    • Remove the App's container settingdelete
    • Modify App's container settingput
    • Get App's default container settingsget
    • Get list of organization's container settingsget
    • Modify organization's container settingspatch
    • Fetch organization's container settingget
    • Modify organization's container settingput
  • Meta sites
    • List meta sitesget
    • Add meta sitepost
    • Get meta siteget
    • Edit meta sitepatch
    • Delete meta sitedelete
    • Add apps to meta sitepost
    • Remove apps from meta sitedelete
    • List apps in meta siteget
    • List apps excluded from meta siteget
    • List apps & meta sitesget
    • Meta site integrityget
  • Modules
    • Modules listget
    • Modules list for given userspost
    • Moduleget
    • Modules access list for a given userget
    • Set modules access for a given userput
  • OAuth
    • Issue OAuth Tokenpost
  • Tag Manager
    • Get list of changesget
    • List of debug links for a given versionget
    • Create debug linkpost
    • Delete debug linkdelete
    • Get operationget
    • List of tagsget
    • Edit tags orderpatch
    • Create tagpost
    • List of triggers for a given tagget
    • Get tagget
    • Edit tagpatch
    • Delete tagdelete
    • Copy tagpost
    • List of triggersget
    • Create triggerpost
    • List of tags for a given triggerget
    • Get triggerget
    • Edit triggerpatch
    • Delete triggerdelete
    • Copy triggerpost
    • List of variablesget
    • Create variablepost
    • Get variableget
    • Edit variablepatch
    • Delete variabledelete
    • Copy variablepost
    • List of versionsget
    • Get versionget
    • Get draft versionget
    • Get published versionget
    • Restore published versionpost
    • Restore version by idpost
    • Snapshot draft versionpost
    • Create export filepost
    • Get export fileget
    • Publish draft versionpost
    • Publish version by idpost
    • Import versionpost
    • Import version from filepost
  • Tracker
    • Logsget
    • Debuggerget
    • Tracking endpointget
    • Tracking endpointpost
  • Tracker Settings
    • Get global, tracker related settings of appsget
    • Edit global, tracker related settings of appspatch
    • Get global tracker settingsget
    • Edit global tracker settingspatch
    • Get tracker settings of an appget
    • Edit tracker settings of an apppatch
    • Delete given tracker setting of an appdelete
    • Get tracker settings of an app by it's urlget
  • User Groups
    • List user groupsget
    • Add user grouppost
    • Get user groupget
    • Edit user grouppatch
    • Delete user groupdelete
    • Get user group membersget
    • Get users excluded from groupget
    • Add users to user grouppost
    • Remove users from user groupdelete
    • Set permission grouppost
  • Users
    • Invite userpost
    • Create userpost
    • Get users listget
    • Get details of an userget
    • Delete userdelete
    • Edit userpatch
    • Change user rolepatch
    • Change my passwordpatch
    • Current user detailsget
    • Current user detailsget
    • Edit own accountpatch

Metrics & dimensions

When making API calls you can use columns that contain dimensions, metrics and transformations.

When you use one of our integrations, you can also use columns that contain additional metrics and dimensions – like the ones from Google Ads, Google Search Console, SharePoint.

Next steps

  • Piwik PRO: metrics & dimensions
  • Google Ads: metrics & dimensions
  • Google Search Console: metrics & dimensions
  • SharePoint: metrics & dimensions
  • Exporter: dimensions