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

# EnterpriseMetricsClient

## Constructor

```typescript
EnterpriseMetricsClient(options: BaseClientOptions): MetricsClient
```

### Parameters

**options** `BaseClientOptions` *required*

### Returns

`MetricsClient`

## Methods

### getActiveUsersMetrics()

```typescript
getActiveUsersMetrics(request: GetActiveUsersMetricsMetricsRequest, requestOptions?: RequestOptions): HttpResponsePromise<ActiveUserMetricsResponse>
```

Get unique active users for a custom date range.

A user is considered active if they have created at least min\_sessions sessions
OR at least min\_searches searches within the specified time range.

Returns a single count of unique active users across the entire range.

```ts
await client.enterprise.metrics.getActiveUsersMetrics({
        time_before: 1,
        time_after: 1
    })
```

#### Parameters

**request** `GetActiveUsersMetricsMetricsRequest` *required*

**requestOptions** `RequestOptions`

Request-specific configuration.

#### Returns

`HttpResponsePromise<ActiveUserMetricsResponse>`

### getDauMetrics()

```typescript
getDauMetrics(request: GetDauMetricsMetricsRequest, requestOptions?: RequestOptions): HttpResponsePromise<ActiveUserMetricsListResponse>
```

Get daily active users for each day in the specified time range.

A user is considered active on a given day if they have created at least
min\_sessions sessions OR at least min\_searches searches during that UTC day.

Returns a list of daily active user counts, one entry per day in the range.

```ts
await client.enterprise.metrics.getDauMetrics({
        time_before: 1,
        time_after: 1
    })
```

#### Parameters

**request** `GetDauMetricsMetricsRequest` *required*

**requestOptions** `RequestOptions`

Request-specific configuration.

#### Returns

`HttpResponsePromise<ActiveUserMetricsListResponse>`

### getMauMetrics()

```typescript
getMauMetrics(request: GetMauMetricsMetricsRequest, requestOptions?: RequestOptions): HttpResponsePromise<ActiveUserMetricsListResponse>
```

Get monthly active users for each month in the specified time range.

A user is considered active in a given month if they have created at least
min\_sessions sessions OR at least min\_searches searches during that UTC month.

Returns a list of monthly active user counts, one entry per month in the range.

```ts
await client.enterprise.metrics.getMauMetrics({
        time_before: 1,
        time_after: 1
    })
```

#### Parameters

**request** `GetMauMetricsMetricsRequest` *required*

**requestOptions** `RequestOptions`

Request-specific configuration.

#### Returns

`HttpResponsePromise<ActiveUserMetricsListResponse>`

### getOrganizationUsageMetrics()

```typescript
getOrganizationUsageMetrics(request: GetOrganizationUsageMetricsMetricsRequest, requestOptions?: RequestOptions): HttpResponsePromise<UsageMetrics>
```

Get aggregated usage metrics for the enterprise account.

Returns counts of sessions, searches, and PRs (opened, closed, merged)
within the specified time range.

```ts
await client.enterprise.metrics.getOrganizationUsageMetrics({
        org_id: "org-abc123def456"
    })
```

#### Parameters

**request** `GetOrganizationUsageMetricsMetricsRequest` *required*

**requestOptions** `RequestOptions`

Request-specific configuration.

#### Returns

`HttpResponsePromise<UsageMetrics>`

### getPrMetrics()

```typescript
getPrMetrics(request: GetPrMetricsMetricsRequest, requestOptions?: RequestOptions): HttpResponsePromise<PrMetricsResponse>
```

Get aggregated PR metrics for the enterprise account.

Optionally filter by playbook\_id to get metrics for PRs from sessions created with a specific playbook.

```ts
await client.enterprise.metrics.getPrMetrics({
        time_before: 1,
        time_after: 1
    })
```

#### Parameters

**request** `GetPrMetricsMetricsRequest` *required*

**requestOptions** `RequestOptions`

Request-specific configuration.

#### Returns

`HttpResponsePromise<PrMetricsResponse>`

### getSearchMetrics()

```typescript
getSearchMetrics(request: GetSearchMetricsMetricsRequest, requestOptions?: RequestOptions): HttpResponsePromise<SearchMetricsResponse>
```

Get aggregated search metrics for the enterprise account.

```ts
await client.enterprise.metrics.getSearchMetrics({
        time_before: 1,
        time_after: 1
    })
```

#### Parameters

**request** `GetSearchMetricsMetricsRequest` *required*

**requestOptions** `RequestOptions`

Request-specific configuration.

#### Returns

`HttpResponsePromise<SearchMetricsResponse>`

### getSessionMetrics()

```typescript
getSessionMetrics(request: GetSessionMetricsMetricsRequest, requestOptions?: RequestOptions): HttpResponsePromise<SessionMetricsResponse>
```

Get aggregated session metrics for the enterprise account.

Optionally filter by playbook\_id to get metrics for sessions created with a specific playbook.

```ts
await client.enterprise.metrics.getSessionMetrics({
        time_before: 1,
        time_after: 1
    })
```

#### Parameters

**request** `GetSessionMetricsMetricsRequest` *required*

**requestOptions** `RequestOptions`

Request-specific configuration.

#### Returns

`HttpResponsePromise<SessionMetricsResponse>`

### getSessionsByCategory()

```typescript
getSessionsByCategory(request: GetSessionsByCategoryMetricsRequest, requestOptions?: RequestOptions): HttpResponsePromise<SessionsByCategoryResponse>
```

Get session counts and ACU consumption grouped by category and subcategory.

```ts
await client.enterprise.metrics.getSessionsByCategory({
        time_before: 1,
        time_after: 1
    })
```

#### Parameters

**request** `GetSessionsByCategoryMetricsRequest` *required*

**requestOptions** `RequestOptions`

Request-specific configuration.

#### Returns

`HttpResponsePromise<SessionsByCategoryResponse>`

### getUsageMetrics()

```typescript
getUsageMetrics(request?: GetUsageMetricsMetricsRequest, requestOptions?: RequestOptions): HttpResponsePromise<UsageMetrics>
```

Get aggregated usage metrics for the enterprise account.

Returns counts of sessions, searches, and PRs (opened, closed, merged)
within the specified time range.

```ts
await client.enterprise.metrics.getUsageMetrics()
```

#### Parameters

**request** `GetUsageMetricsMetricsRequest`

**requestOptions** `RequestOptions`

Request-specific configuration.

#### Returns

`HttpResponsePromise<UsageMetrics>`

### getWauMetrics()

```typescript
getWauMetrics(request: GetWauMetricsMetricsRequest, requestOptions?: RequestOptions): HttpResponsePromise<ActiveUserMetricsListResponse>
```

Get weekly active users for each week in the specified time range.

A user is considered active in a given week if they have created at least
min\_sessions sessions OR at least min\_searches searches during that UTC week.

Weeks are defined as Monday 00:00:00 UTC to Sunday 23:59:59 UTC.

Returns a list of weekly active user counts, one entry per week in the range.

```ts
await client.enterprise.metrics.getWauMetrics({
        time_before: 1,
        time_after: 1
    })
```

#### Parameters

**request** `GetWauMetricsMetricsRequest` *required*

**requestOptions** `RequestOptions`

Request-specific configuration.

#### Returns

`HttpResponsePromise<ActiveUserMetricsListResponse>`


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