> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Microsoft Clarity API reference

> API reference for Microsoft Clarity: every `microsoftclarity.api.*` operation with input and output types.

> [!NOTE]
>
> **New to Corsair?** See [API access](https://docs.corsair.dev/concepts/api.md), [authentication](https://docs.corsair.dev/concepts/auth.md), and [error handling](https://docs.corsair.dev/concepts/error-handling).

## Insights

### get

`insights.get`

Export project dashboard metrics for the past 1 to 3 days with optional dimension breakdowns

**Risk:** `read`

```ts theme={null}
await corsair.microsoftclarity.api.insights.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `numOfDays` | `number` | Yes | — |
| `dimension1` | `string` | No | — |
| `dimension2` | `string` | No | — |
| `dimension3` | `string` | No | — |

Use `numOfDays` 1, 2, or 3 and up to three optional dimension values. Metric information fields vary with the metric and requested breakdown; counts can be numbers or strings, and averages are null when the project had no traffic.

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   metricName: string,
>   information: {
>     totalSessionCount?: string | number | null,
>     totalBotSessionCount?: string | number | null,
>     distinctUserCount?: string | number | null,
>     distantUserCount?: string | number | null,
>     pagesPerSessionPercentage?: number | null,
>     PagesPerSessionPercentage?: number | null,
>     OS?: string | null
>   }[]
> }[]
> ```

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.