View as Markdown
Microsoft Clarity icon

Microsoft Clarity ACTION

Get Live Insights

Fetch real-time analytics metrics for your Microsoft Clarity project, optionally broken down by up to three dimensions. Returns an array of metric objects (e.g. Traffic, Scroll Depth, Engagement Time, Dead Clicks, Rage Clicks, Script Errors) each with a metricName and an information array of data points. Use dimension1, dimension2, and dimension3 to segment data by Browser, Device, Country/Region, OS, Source, Medium, Campaign, Channel, or URL. Rate limit: 10 requests per project per day — combine all desired dimensions into a single call rather than issuing multiple requests. Results are limited to 1,000 rows with no pagination. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Microsoft Clarity account once, then configure and run Get Live Insights from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "microsoft_clarity-get-live-insights",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    microsoft_clarity: { authProvisionId: "apn_xxxxxxx" },
    numOfDays: "Time Range",
    dimension1: "Dimension 1",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Get Live Insights inputs
Property Type Description
numOfDays Time Range string
The time window for the analytics data.
Required
dimension1 Dimension 1 string
Primary dimension to group analytics data by (e.g. Device, Country, Browser). Omit for aggregate totals only.
Optional
dimension2 Dimension 2 string
Secondary dimension for cross-segment breakdown (e.g. OS when Dimension 1 is Device). Must differ from Dimension 1.
Optional
dimension3 Dimension 3 string
Tertiary dimension for further segmentation. Must differ from Dimension 1 and Dimension 2.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
microsoft_clarity-get-live-insights
Version
0.0.2
App
Microsoft Clarity
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes