Matomo icon

Matomo

Use the Matomo API

Actions542

Action → Get Actions

AI-generated

Summary

Retrieve metrics and details of user actions for specified site(s) and time periods using the Matomo API's Actions resource.

Inputs

  • queryParameters — Collection of query parameters to filter and customize the data retrieved, such as site ID, date, period, actionName, actionType, limit, offset, segment, and many other optional parameters to refine the querying of actions data.

Output shape

a JSON array containing the API response with actions data including metrics and details per the specified query parameters.

The response format depends on the API and may vary; it typically returns a structured JSON object with action metrics for the specified site(s) and date range. If no data is found, the operation returns a status indicating no content. The output may include paginated results depending on limit and offset parameters.

Examples

Example 1: Fetch all user actions for site with ID 1 during a specific day.

Set queryParameters with idSite=1, date=YYYY-MM-DD, period=day.

Example 2: Retrieve top 25 page titles accessed in the last week for a given site.

Set queryParameters with idSite to the target site ID, period=week, limit=25.

Discussion