Actions539
- Funnel Actions
- Get Funnel Flow
- Get Funnel Step Subtable
- Get Metrics
- Get Sales Funnel For Site
- Save Non Goal Funnel
- Set Goal Funnel
- Test Url Matches Steps
- Delete Goal Funnel
- Get Available Pattern Matches
- Get Funnel Entries
- Get Funnel Flow Table
- Get Goal Funnel
- Has Any Activated Funnel For Site
- Delete Non Goal Funnel
- Get Funnel Exits
- Get All Activated Funnels For Site
- Get Funnel
- Goal Actions
- Heatmap Session Recording Actions
- Add Heatmap
- Delete Heatmap
- Delete Heatmap Screenshot
- Delete Recorded Pageview
- Duplicate Heatmap
- End Session Recording
- Get Available Device Types
- Get Available Heatmap Types
- Get Available Target Page Rules
- Get Embed Session Info
- Get Heatmap
- Get Recorded Session
- Get Recorded Heatmap Metadata
- Get Session Recording
- Get Session Recordings
- Pause Heatmap
- Resume Session Recording
- Resume Heatmap
- Update Session Recording
- Update Heatmap
- Delete Recorded Session
- Add Session Recording
- Delete Session Recording
- End Heatmap
- Get Available Session Recording Sample Limits
- Get Available Statuses
- Get Event Types
- Get Heatmaps
- Get Recorded Sessions
- Pause Session Recording
- Test Url Match Pages
- Get Recorded Heatmap
- Image Graph Actions
- Insight Actions
- Languages Manager Actions
- Live Actions
- Marketing Campaigns Reporting Actions
- Media Actions
- Mobile Messaging Actions
- Multi Channel Conversion Attribution Actions
- Multi Site Actions
- Overlay Actions
- Privacy Manager Actions
- Referrer Actions
- Get All
- Get Campaigns
- Get Keywords From Campaign ID
- Get Keywords From Search Engine ID
- Get Number Of Distinct AI Assistants
- Get Number Of Distinct Keywords
- Get Number Of Distinct Search Engines
- Get Number Of Distinct Social Networks
- Get Referrer
- Get Search Engines
- Get Search Engines From Keyword ID
- Get URLs For AI Assistant
- Get URLs From Website ID
- Get Number Of Distinct Campaigns
- Get AI Assistants
- Get Keywords
- Get Number Of Distinct Websites
- Get Referrer Type
- Get Socials
- Get URLs For Social
- Get Websites
- Get Number Of Distinct Websites URLs
- Resolution Actions
- Roll Up Reporting Actions
- Scheduled Report Actions
- Search Engine Keywords Performance Actions
- Segment Editor Actions
- Sites Manager Actions
- Add Site
- Add Site Alias Urls
- Get All Sites
- Get Currency List
- Get Currency Symbols
- Get Default Currency
- Get Excluded IPs Global
- Get Excluded Query Parameters
- Get Excluded Referrers
- Get Exclusion Type For Query Params
- Get Image Tracking Code
- Get Javascript Tag
- Get Num Websites To Display Per Page
- Get Pattern Match Sites
- Get Site From ID
- Get Site Urls From ID
- Get Sites From Group
- Get Sites ID From Site URL
- Get Sites ID With At Least View Access
- Get Sites ID With View Access
- Get Sites ID With Write Access
- Get Sites With At Least View Access
- Get Sites With View Access
- Get Timezones List
- Get Unique Site Timezones
- Rename Group
- Set Default Currency
- Set Global Excluded IPs
- Set Default Timezone
- Set Global Excluded User Agents
- Set Global Query Param Exclusion
- Update Site
- Set Site Alias URLs
- Get Sites ID With Admin Access
- Get Timezone Name
- Delete Site
- Get All Sites ID
- Get Default Timezone
- Get Excluded Query Parameters Global
- Get Excluded Referrers Global
- Get IPs For Range
- Get Keep URL Fragments Global
- Get Search Category Parameters Global
- Get Site Settings
- Get Sites Groups
- Get Sites With Admin Access
- Get Sites With Minimum Access
- Is Timezone Support Enabled
- Set Global Excluded Referrers
- Set Global Search Parameters
- Get Search Keyword Parameters Global
- Set Keep URL Fragments Global
- Tag Manager Actions
- Add Container Tag
- Add Container Variable
- Change Debug Url
- Create Container Version
- Delete Container
- Delete Container Tag
- Delete Container Variable
- Disable Preview Mode
- Enable Preview Mode
- Get Available Contexts
- Get Available Environments With Publish Capability
- Get Available Tag Fire Limits
- Get Available Trigger Types In Context
- Get Available Variable Types In Context
- Get Container Install Instructions
- Get Container Tags
- Get Container Trigger References
- Get Container Variable
- Get Container Variable References
- Get Container Variables
- Get Container Version
- Get Container Versions
- Import Container Version
- Publish Container Version
- Resume Container Tag
- Update Container Tag
- Update Container Variable
- Update Container Version
- Get Available Container Variables
- Add Container
- Add Container Trigger
- Create Default Container For Site
- Delete Container Trigger
- Delete Container Version
- Export Container Version
- Get Available Environments
- Get Available Tag Types In Context
- Get Container Embed Code
- Get Container Tag
- Get Container Triggers
- Get Containers
- Pause Container Tag
- Update Container
- Update Container Trigger
- Get Available Comparisons
- Get Container Trigger
- Tour Actions
- Transition Actions
- Two Factor Auth Actions
- User Country Actions
- Users Flow Actions
- Users Manager Actions
- Add User
- Get Available Roles
- Get Sites Access For User
- Get User
- Get User By Email
- Get User Preference
- Get Users Access From Site
- Get Users Having Super User Access
- Get Users Plus Role
- Get Users Sites From Access
- Has Super User Access
- Set Super User Access
- Set User Preference
- Update User
- User Exists
- Get Users
- Add Capabilities
- Delete User
- Get Sites Access From User
- Get User Login From User Email
- Get Users Login
- Get Users With Site Access
- Invite User
- Set User Access
- User Email Exists
- Get Available Capabilities
- Visit Frequency Actions
- Visit Time Actions
- Visitor Interest Actions
- Visits Summary Actions
- Action Actions
- Get Entry Page Titles
- Get Downloads
- Get Download
- Get Exit Page Titles
- Get Entry Page URLs
- Get Exit Page URLs
- Get Outlink
- Get Page Title
- Get Outlinks
- Get Page Titles
- Get Page Titles Following Site Search
- Get Page URL
- Get Page URLs
- Get Page URLs Following Site Search
- Get Site Search Categories
- Get Site Search Keywords
- Get Site Search No Result Keywords
- API Actions
- Get Processed Report
- Get Suggested Values For Segment
- Get Generic API Report
- Get Glossary Metrics
- Get Glossary Reports
- Get IP From Header
- Get Matomo Version
- Get Metadata
- Get Pages Comparisons Disabled For
- Get PHP Version
- Get Plugin Activation
- Get Report Metadata
- Get Report Pages Metadata
- Get Row Evolution
- Get Segments Metadata
- Get Widget Metadata
- Crash Actions
- Get New Crashes
- Get All Crashes
- Get Crash Summary
- Get Crash Types
- Get Crashes By Page URL
- Get Crashes By Source
- Get Crashes For Page URL
- Get Ignored Crashes
- Get Last Disappeared Crashes
- Get Reappeared Crashes
- Merge Crashes
- Set Ignore Crash
- Get Last Top Crashes
- Get All Crash Messages
- Get Crash Data
- Get Crash Groups
- Get Crash Messages
- Get Crash Visit Context
- Get Crashes By Category
- Get Crashes By First Party
- Get Crashes By Page Title
- Get Crashes By Third Party
- Get Crashes For Category
- Get Crashes For Page Title
- Get Crashes For Source
- Get Disappeared Crashes
- Get Last Crashes Overview
- Get Last New Crashes
- Get Last Reappeared Crashes
- Get Unidentified Crash Messages
- Search Crash Messages For Merge
- Unmerge Crash Group
- Dashboard Actions
- Form Actions
- Get Field Timings
- Get All Goals
- Get Available Page Rules
- Get Counters
- Get Drop Off Fields
- Get Form Analytics
- Get Most Used Fields
- Get Page URLs
- Get Auto Creation Settings
- Delete Form
- Add Form
- Archive Form
- Get Available Conversion Rule Options
- Get Available Form Rules
- Get Available Statuses
- Get Current Most Popular Forms
- Get Entry Fields
- Get Field Corrections
- Get Field Size
- Get Form
- Get Forms By Statuses
- Get Forms
- Update Form
- Update Form Field Display Name
- Get Uneeded Fields
- SEO Actions
- Content Actions
- Core Admin Home Actions
- Custom Alert Actions
- Custom Dimension Actions
- Custom Report Actions
- Devices Detection Actions
- Event Actions
- Feedback Actions
- Login Actions
- Page Performance Actions
- User ID Actions
- AB Testing Actions
- Get Available Statuses
- Add Experiment
- Archive Experiment
- Delete Experiment
- Finish Experiment
- Get Active Experiments
- Get All Experiments
- Get Available Success Metrics
- Get Available Target Attributes
- Get Experiment
- Get Experiments With Reports
- Get JS Experiment Template
- Get JS Include Template
- Get Metric Details
- Get Metrics Overview
- Start Experiment
- Update Experiment
- Annotation Actions
- Activity Log Actions
- Advertising Conversion Export Actions
- Connect Account Actions
- Custom JS Tracker Actions
- Custom Variable Actions
- Device Plugin Actions
Overview
This node interacts with the Matomo API to perform various operations related to the 'Custom Dimension' resource, specifically the 'Get Configured Custom Dimensions Having Scope' operation. It allows users to retrieve configured custom dimensions filtered by their scope for a given site. This is useful for analytics and tracking customization in Matomo, enabling users to fetch detailed dimension configurations based on action, conversion, or visit scope.
Use Case Examples
- Retrieve all configured custom dimensions with the scope set to 'action' for a specific website to analyze user interactions at the action level.
- Fetch custom dimensions with the scope 'visit' to understand visitor-level data segmentation for a site.
Properties
| Name | Meaning |
|---|---|
| Query Parameters | Collection of optional parameters to filter or specify the API request, such as 'scope' to define the data level the custom dimension applies to. |
Output
JSON
json- The JSON response from the Matomo API containing the configured custom dimensions filtered by scope.
Dependencies
- Matomo API credentials (domain and auth token) are required for authentication.
Troubleshooting
- Ensure that the Matomo domain and authentication token are correctly configured; missing these will cause authentication errors.
- Verify that the 'scope' parameter is set correctly to one of the allowed values ('action', 'conversion', 'visit') to avoid empty or invalid responses.
- Check network connectivity and Matomo API availability if requests fail or time out.
- If the API returns an error, review the error message for details and ensure the user has the necessary permissions to access custom dimension data.
Links
- Matomo API - CustomDimensions.getConfiguredCustomDimensionsHavingScope - Official Matomo API documentation for retrieving configured custom dimensions by scope.