This API is the Metadata API: it gives information about all other available APIs methods, as well as providing human readable and more complete outputs than normal API methods. Some of the information that is returned by the Metadata API:

• the dynamically generated list of all API methods via "getReportMetadata"
• the list of metrics that will be returned by each method, along with their human readable name, via "getDefaultMetrics" and "getDefaultProcessedMetrics"
• the list of segments metadata supported by all functions that have a 'segment' parameter
• the (truly magic) method "getProcessedReport" will return a human readable version of any other report, and include the processed metrics such as conversion rate, time on site, etc. which are not directly available in other methods.
• the method "getSuggestedValuesForSegment" returns top suggested values for a particular segment. It uses the Live.getLastVisitsDetails API to fetch the most recently used values, and will return the most often used values first.

The Metadata API is for example used by the Matomo Mobile App to automatically display all Matomo reports, with translated report & columns names and nicely formatted values. More information on the Metadata API documentation page

The Actions API lets you request reports for all your Visitor Actions: Page URLs, Page titles, Events, Content Tracking, File Downloads and Clicks on external websites. For example, "getPageTitles" will return all your page titles along with standard Actions metrics for each row. It is also possible to request data for a specific Page Title with "getPageTitle" and setting the parameter pageName to the page title you wish to request. Similarly, you can request metrics for a given Page URL via "getPageUrl", a Download file via "getDownload" and an outlink via "getOutlink". Note: pageName, pageUrl, outlinkUrl, downloadUrl parameters must be URL encoded before you call the API.

The Activity Log API is used to get the activity logs for users in your Matomo instance.

The method ActivityLog.getEntries returns a list of the activities done by users in your Matomo instance.
The list of activities returned depends on which user is calling the API:
- if you authenticate with a Super User access, the API will return activity logs for all users
- if you authenticate as anonymous (no authentication), or a user with view or admin access, only this user's activity will be returned.

Each activity includes an activity ID, the user who initiated the activity, a list of parameters/metadata specific to this activity, the datetime (and pretty datetime), the activity description, and the URL to the colored avatar image for this user.

The activity log includes over 80 different types of Matomo activities, for example:
- See when a user logged in, failed to log in, or logged out
- See when a user was created, updated or deleted by who
- See when a website was created, updated or deleted by who
- See when a Matomo setting, an A/B Test, a Scheduled Report, or a Segment was changed and by who

API for annotations plugin. Provides methods to create, modify, delete & query annotations.

API for plugin Contents

The Crash Analytics API lets you 1) ignore/unignore crashes tracked by Matomo 2) request information about individual crashes and 3) request all your Crash Analytics reports and metrics. 1) You can ignore crashes so they will no longer be tracked, or unignore previously ignored crashes so they will reappear again in your reports.

2) You can merge different crashes together so they will be treated as a single crash in reports, or unmerge previously merged groups. You can also get the list of all merged crash groups for a site.

3) You can request summarized information about a single crash as well as query the entire list of raw tracked crash information:
- get a list of all the different crash types that were tracked via CrashAnalytics.getCrashTypes
- get the list of currently ignored crashes via CrashAnalytics.getIgnoredCrashes
- get summarized information about a single crash via CrashAnalytics.getCrashSummary
- get information about the actions that preceeded a crash via CrashAnalytics.getCrashVisitContext
- query every crash that has been tracked for a site via CrashAnalytics.getAllCrashes

4) Request all metrics and reports about crashes that occur on your website:
- How often different crash messages appear and which source file originated them
- Which crashes have disappeared and not been seen in the last several days
- Which crashes have recently reappeared after an absence
- Which crashes are new and have never been seen before
- Which pages have the most crashes and what those crashes are
- Which source files generate the most crashes and what those crashes are
- Which crash categories appear the most and what crashes appear for those categories
- Which crashes originate from first party source files (in other words, source files hosted by your website)
- Which crashes originate from third party source files (in other words, source files from third party websites, generally outside your control)
- What crashes are currently occurring on your website, within the last N minutes
- Which of the crashes that are currently occurring are new
- Which of the crashes that are currently occurring were absent but have reappeared
- What crashes have just been absent long enough to be considered "disappeared"

And the following metrics:
- How many times a crash occurs
- How often a visit encounters at least one crash
- How many unique crashes were tracked
- How many new crashes were tracked
- How many crashes that were tracked were absent for some time, but have since reappeared
- How often a page view encounters at least one crash
- How many crashes are currently ignored

The Custom Dimensions API lets you manage and access reports for your configured Custom Dimensions.

API for plugin CustomJsTracker

The Custom Reports API lets you 1) create custom reports within Matomo and 2) view the created reports in the Matomo Reporting UI or consume them via the API.

You can choose between different visualizations (eg table or evolution graph) and combine hundreds of dimensions and metrics to get the data you need.

The Custom Variables API lets you access reports for your Custom Variables names and values.

This API is the Dashboard API: it gives information about dashboards.

The DevicePlugins API lets you access reports about device plugins such as browser plugins.

The DevicesDetection API lets you access reports on your visitors devices, brands, models, Operating system, Browsers.

The Events API lets you request reports about your users' Custom Events. Events are tracked using the Javascript Tracker trackEvent() function, or using the [Tracking HTTP API](http://developer.matomo.org/api-reference/tracking-api).
An event is defined by an event category (Videos, Music, Games...), an event action (Play, Pause, Duration, Add Playlist, Downloaded, Clicked...), and an optional event name (a movie name, a song title, etc.) and an optional numeric value.
This API exposes the following Custom Events reports: getCategory lists the top Event Categories, getAction lists the top Event Actions, getName lists the top Event Names.
These Events report define the following metrics: nb_uniq_visitors, nb_visits, nb_events. If you define values for your events, you can expect to see the following metrics: nb_events_with_value, sum_event_value, min_event_value, max_event_value, avg_event_value
The Events.get* reports can be used with an optional &secondaryDimension parameter. Secondary dimension is the dimension used in the sub-table of the Event report you are requesting.
Here are the possible values of secondaryDimension:

• For Events.getCategory you can set secondaryDimension to eventAction or eventName.
• For Events.getAction you can set secondaryDimension to eventName or eventCategory.
• For Events.getName you can set secondaryDimension to eventAction or eventCategory.

For example, to request all Custom Events Categories, and for each, the top Event actions, you would request: method=Events.getCategory&secondaryDimension=eventAction&flat=1. You may also omit &flat=1 in which case, to get top Event actions for one Event category, use method=Events.getActionFromCategoryId passing it the &idSubtable= of this Event category.

API for plugin Feedback

The Form Analytics API lets you 1) manage forms within Matomo and 2) request all your form analytics reports and metrics.

1) You can create, update, delete forms, as well as request any form and also archive them.

2) Request all metrics and reports about how users interact with your forms:
- Form usage by page URL to see whether the same form is used differently on different pages.
- Entry fields to see where they start filling out your forms.
- Drop off fields to see where your users leave your forms.
- Field timings report to see where your users spent the most time.
- Field size report to see how much text your users type.
- Most corrected fields report to learn more about where users have problems filling out your form.
- Unneeded fields report to see which fields are often left blank.
- Several evolution reports of all metrics to see how your forms perform over time.

And the following metrics:
- How often was a form field interacted with (eg. focus or change).
- Which fields did your visitors interact with first when they started filling out a form.
- Which fields caused a visitor to stop filling out a form (drop offs).
- How often your visitors changed a form field or made amendments.
- How often a field was refocused or corrected (eg usage of backspace or delete key, cursor keys, …).
- How much text they type into each of your text fields.
- Which fields are unneeded and often left blank.
- How long visitors hesitated (waited) before they started changing a field.
- How much time your visitors spent on each field.

API for plugin Funnels

Goals API lets you Manage existing goals, via "updateGoal" and "deleteGoal", create new Goals via "addGoal", or list existing Goals for one or several websites via "getGoals" If you are tracking Ecommerce orders and products on your site, the functions "getItemsSku", "getItemsName" and "getItemsCategory" will return the list of products purchased on your site, either grouped by Product SKU, Product Name or Product Category. For each name, SKU or category, the following metrics are returned: Total revenue, Total quantity, average price, average quantity, number of orders (or abandoned carts) containing this product, number of visits on the Product page, Conversion rate. By default, these functions return the 'Products purchased'. These functions also accept an optional parameter &abandonedCarts=1. If the parameter is set, it will instead return the metrics for products that were left in an abandoned cart therefore not purchased. The API also lets you request overall Goal metrics via the method "get": Conversions, Visits with at least one conversion, Conversion rate and Revenue. If you wish to request specific metrics about Ecommerce goals, you can set the parameter &idGoal=ecommerceAbandonedCart to get metrics about abandoned carts (including Lost revenue, and number of items left in the cart) or &idGoal=ecommerceOrder to get metrics about Ecommerce orders (number of orders, visits with an order, subtotal, tax, shipping, discount, revenue, items ordered) See also the documentation about Tracking Goals in Matomo.

API for plugin Heatmap & Session Recording. When you request activity data for a heatmap or a recorded session, please note that any X or Y coordinate, scroll reach position, and above the fold is relative and not absolute. X and Y coordinate are between 0 and 2000 and are relative to the selector where 2000 means the position is at 100% of the element, 1000 means the position is at 50% and 0 means the position is actually 0 pixel from the element. Scroll and above the fold positions are between 0 and 1000. If for example a web page is 3000 pixel high, and scroll reach is 100, it means the user has seen the content up to 300 pixels (10%, or 100 of 1000). We differentiate between two different IDs here: idSiteHsr represents the ID of a heatmap or session recording configuration idLogHsr represents the ID of an actually recorded / tracked session or heatmap activity

The ImageGraph.get API call lets you generate beautiful static PNG Graphs for any existing Matomo report. Supported graph types are: line plot, 2D/3D pie chart and vertical bar chart. A few notes about some of the parameters available:
- $graphType defines the type of graph plotted, accepted values are: 'evolution', 'verticalBar', 'pie' and '3dPie'
- $colors accepts a comma delimited list of colors that will overwrite the default Matomo colors
- you can also customize the width, height, font size, metric being plotted (in case the data contains multiple columns/metrics). See also How to embed static Image Graphs? for more information.

API for plugin Insights

The LanguagesManager API lets you access existing Matomo translations, and change Users languages preferences. "getTranslationsForLanguage" will return all translation strings for a given language, so you can leverage Matomo translations in your application (and automatically benefit from the 40+ translations!). This is mostly useful to developers who integrate Matomo API results in their own application. You can also request the default language to load for a user via "getLanguageForUser", or update it via "setLanguageForUser".

The Live! API lets you access complete visit level information about your visitors. Combined with the power of Segmentation, you will be able to request visits filtered by any criteria. The method "getLastVisitsDetails" will return extensive RAW data for each visit, which includes: server time, visitId, visitorId, visitorType (new or returning), number of pages, list of all pages (and events, file downloaded and outlinks clicked), custom variables names and values set to this visit, number of goal conversions (and list of all Goal conversions for this visit, with time of conversion, revenue, URL, etc.), but also other attributes such as: days since last visit, days since first visit, country, continent, visitor IP, provider, referrer used (referrer name, keyword if it was a search engine, full URL), campaign name and keyword, operating system, browser, type of screen, resolution, supported browser plugins (flash, java, silverlight, pdf, etc.), various dates & times format to make it easier for API users... and more! With the parameter '&segment=' you can filter the returned visits by any criteria (visitor IP, visitor ID, country, keyword used, time of day, etc.). The method "getCounters" is used to return a simple counter: visits, number of actions, number of converted visits, in the last N minutes. See also the documentation about Real time widget and visitor level reports in Matomo. You may also be interested in steps to export your RAW data to a data warehouse.

API for plugin Login

API for plugin MarketingCampaignsReporting

The MediaAnalytics API lets you request your reports about how your Video and Audio are accessed and viewed on your websites and apps. Some of the methods return Real Time information (similarly to the Live! API), while others return all your videos and audios and their key metrics.

The real time methods can return information about the last N minutes (or last N hours). They include the following:

• the method getCurrentNumPlays returns the number of video plays (and audio plays) in the last N minutes
• the method getCurrentSumTimeSpent returns the the total time users spent playing your media in the last N minutes
• the method getCurrentMostPlays returns the most popular videos in the last N minutes.

The other methods return the aggregated analytics reports for Video and Audio:

• MediaAnalytics.get returns the overall metrics for your videos and audios: nb_plays, nb_unique_visitors_plays, nb_impressions, nb_unique_visitors_impressions, nb_finishes, sum_total_time_watched, sum_total_audio_plays, sum_total_audio_impressions, sum_total_video_plays, sum_total_video_impressions, play_rate, finish_rate, impression_rate.
• getVideoTitles and getAudioTitles return the list of videos / audio by video title and audio title.
• getGroupedVideoResources and getGroupedAudioResources return the list of watched videos / audio grouped by resource URL. The "grouped media resource" report displays a flat report which includes both the domain and the path to the media resource, whereas the regular "media resource" report displays a hierarchical view of your media resources by domain.
• getVideoHours and getAudioHours return the list of videos / audio by by hour (to see how your media is consumed at a different time of the day).
• getVideoTitles and getAudioTitles return the list of videos / audio by video title and audio title.
• getVideoResolutions return the list of videos by player resolution (see how your videos are consumed when the video resolution varies).
• getPlayers return the watched media by media player.

The MobileMessaging API lets you manage and access all the MobileMessaging plugin features including : - manage SMS API credential - activate phone numbers - check remaining credits - send SMS

Multi Channel Conversion Attribution API

The MultiSites API lets you request the key metrics (visits, page views, revenue) for all Websites in Matomo.

Class API

API for plugin PrivacyManager

The Referrers API lets you access reports about Websites, Search engines, Keywords, Campaigns used to access your website. For example, "getKeywords" returns all search engine keywords (with general analytics metrics for each keyword), "getWebsites" returns referrer websites (along with the full Referrer URL if the parameter &expanded=1 is set). "getReferrerType" returns the Referrer overview report. "getCampaigns" returns the list of all campaigns (and all campaign keywords if the parameter &expanded=1 is set).

API for plugin RollUpReporting

The SEO API lets you access a list of SEO metrics for the specified URL: Google PageRank, Google/Bing indexed pages and age of the Domain name.

The ScheduledReports API lets you manage Scheduled Email reports, as well as generate, download or email any existing report. "generateReport" will generate the requested report (for a specific date range, website and in the requested language). "sendReport" will send the report by email to the recipients specified for this report. You can also get the list of all existing reports via "getReports", create new reports via "addReport", or manage existing reports with "updateReport" and "deleteReport". See also the documentation about Scheduled Email reports in Matomo.

The SearchEngineKeywordsPerformance API lets you download all your SEO search keywords from Google, Bing & Yahoo and Yandex, as well as getting a detailed overview of how search robots crawl your websites and any error they may encounter.

1) download all your search keywords as they were searched on Google, Bing & Yahoo and Yandex. This includes Google Images, Google Videos and Google News. This lets you view all keywords normally hidden from view behind "keyword not defined". With this plugin you can view them all!

2) download all crawling overview stats and metrics from Bring and Yahoo and Google. Many metrics are available such as: Crawled pages, Crawl errors, Connection timeouts, HTTP-Status Code 301 (Permanently moved), HTTP-Status Code 400-499 (Request errors), All other HTTP-Status Codes, Total pages in index, Robots.txt exclusion, DNS failures, HTTP-Status Code 200-299, HTTP-Status Code 301 (Temporarily moved), HTTP-Status Code 500-599 (Internal server errors), Malware infected sites, Total inbound links. \Plugins\SearchEngineKeywordsPerformance

The SegmentEditor API lets you add, update, delete custom Segments, and list saved segments.

The SitesManager API gives you full control on Websites in Matomo (create, update and delete), and many methods to retrieve websites based on various attributes. This API lets you create websites via "addSite", update existing websites via "updateSite" and delete websites via "deleteSite". When creating websites, it can be useful to access internal codes used by Matomo for currencies via "getCurrencyList", or timezones via "getTimezonesList". There are also many ways to request a list of websites: from the website ID via "getSiteFromId" or the site URL via "getSitesIdFromSiteUrl". Often, the most useful technique is to list all websites that are known to a current user, based on the token_auth, via "getSitesWithAdminAccess", "getSitesWithViewAccess" or "getSitesWithAtLeastViewAccess" (which returns both). Some methods will affect all websites globally: "setGlobalExcludedIps" will set the list of IPs to be excluded on all websites, "setGlobalExcludedQueryParameters" will set the list of URL parameters to remove from URLs for all websites. The existing values can be fetched via "getExcludedIpsGlobal" and "getExcludedQueryParametersGlobal". See also the documentation about Managing Websites in Matomo.

API for plugin Tag Manager. Lets you configure all your containers, create, update and delete tags, triggers, and variables. Create and publish new releases, enable and disable preview/debug mode, and much more. Please note: A container may have several versions. The current version that a user is editing is called the "draft" version. You can get the ID of the "draft" version by calling {@link TagManager.getContainer}.

API for Tour plugin which helps you getting familiar with Matomo.

The UserCountry API lets you access reports about your visitors' Countries and Continents.

API for plugin UserId. Allows to get User IDs table.

The UserLanguage API lets you access reports about your Visitors language setting

API for Users Flow. The API lets you explore details about how your users or visitors navigate through your website.

The UsersManager API lets you Manage Users and their permissions to access specific websites. You can create users via "addUser", update existing users via "updateUser" and delete users via "deleteUser". There are many ways to list users based on their login "getUser" and "getUsers", their email "getUserByEmail", or which users have permission (view or admin) to access the specified websites "getUsersWithSiteAccess". Existing Permissions are listed given a login via "getSitesAccessFromUser", or a website ID via "getUsersAccessFromSite", or you can list all users and websites for a given permission via "getUsersSitesFromAccess". Permissions are set and updated via the method "setUserAccess". See also the documentation about Managing Users in Matomo.

VisitFrequency API lets you access a list of metrics related to Returning Visitors.

VisitTime API lets you access reports by Hour (Server time), and by Hour Local Time of your visitors.

VisitorInterest API lets you access two Visitor Engagement reports: number of visits per number of pages, and number of visits per visit duration.

VisitsSummary API lets you access the core web analytics metrics (visits, unique visitors, count of actions (page views & downloads & clicks on outlinks), time on site, bounces and converted visits.