For AI agents: visit https://developers.piwik.pro/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
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
    • Exporter
    • SharePoint
  • Profile attributes
  • Tag Manager
    • Asynchronous operations
    • Tags
    • Built-in variables

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 goaldel
    • 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 annotationdel
    • List System Annotationsget
  • Apps
    • Apps listget
    • App addpost
    • App detailsget
    • App deletedel
    • App editpatch
    • App permissionsget
    • Apps permission for user groupget
  • Audit Log
    • Entry listget
  • Data Activation
    • List activationsget
    • Create activationpost
    • Fetch activationget
    • Update activationput
    • Delete activationdel
    • Activate activationpost
    • List attributesget
    • Create custom attributepost
    • Create custom attribute bulkpost
    • Update custom attributeput
    • Create audiencepost
    • List audiencesget
    • Fetch audienceget
    • Update audienceput
    • Delete audiencedel
    • 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
    • Update attribute accessibilityput
    • Delete profile by identifierdel
    • Get publicly available profile attributesget
    • Fetch activation usage statisticsget
  • 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 settingdel
    • 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 sitedel
    • Add apps to meta sitepost
    • Remove apps from meta sitedel
    • 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 linkdel
    • Get operationget
    • List of tagsget
    • Edit tags orderpatch
    • Create tagpost
    • List of triggers for a tagget
    • Get tagget
    • Edit tagpatch
    • Delete tagdel
    • Copy tagpost
    • List of triggersget
    • Create triggerpost
    • List of tags for a given triggerget
    • Get triggerget
    • Edit triggerpatch
    • Delete triggerdel
    • Copy triggerpost
    • List of variablesget
    • Create variablepost
    • Get variableget
    • Edit variablepatch
    • Delete variabledel
    • Copy variablepost
    • List of versionsget
    • Get versionget
    • Edit versionpatch
    • 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
    • List of triggers related to a given triggerget
    • List of variables for a tagget
    • List of variables for a given triggerget
    • List of tags for a given variableget
    • List of triggers for a given variableget
    • List of variables that are required by the given variableget
    • List of variables that require the given variableget
    • Get version overviewget
  • 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 appdel
    • 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 groupdel
    • Get user group membersget
    • Get users excluded from groupget
    • Add users to user grouppost
    • Remove users from user groupdel
    • Set permission grouppost
  • Users
    • Invite userpost
    • Create userpost
    • Get users listget
    • Get details of an userget
    • Delete userdel
    • Edit userpatch
    • Change user rolepatch
    • Change my passwordpatch
    • Current user detailsget
    • Current user detailsget
    • Edit own accountpatch

Authentication

Updated 7 days ago


Make a first API call
Did this page help you?

Updated 7 days ago


Make a first API call
Did this page help you?
    • Create API keys
    • Create an access token
    • Delete API keys