Microsoft Clarity icon

Microsoft Clarity

Use the Microsoft Clarity API

Overview

This node integrates with the Microsoft Clarity API to retrieve data export reports. It is useful for users who want to programmatically access and analyze website insights collected by Microsoft Clarity, such as user behavior and engagement metrics. For example, a marketing analyst could use this node to fetch detailed reports broken down by various dimensions over the last few days to optimize website performance.

Use Case Examples

  1. Fetch a data export report with specific dimensions to analyze user interactions by device type and location.
  2. Retrieve a report for the last 48 hours to monitor recent website traffic trends.

Properties

Name Meaning
Dimension 1 The first dimension to break down insights in the report.
Dimension 2 The second dimension to break down insights in the report.
Dimension 3 The third dimension to break down insights in the report.
Number Of Days The number of days for the data export since the API call, limited to 1, 2, or 3 days (representing the last 24, 48, or 72 hours respectively).

Output

JSON

  • json - The JSON response containing the data export report from Microsoft Clarity API.

Dependencies

  • Microsoft Clarity API with an API token credential

Troubleshooting

  • Missing or invalid API token will cause authentication errors; ensure the API token is correctly set in credentials.
  • Invalid query parameters or unsupported dimensions may result in API errors; verify the dimension names and number of days are within allowed values.
  • Network or API endpoint issues can cause request failures; check network connectivity and API status.
  • Error messages from the API are wrapped and rethrown with context; review the error message and stack trace for debugging.

Links

Discussion