EnterpriseMetricsClient

Constructor

EnterpriseMetricsClient(options: BaseClientOptions): MetricsClient

Parameters

BaseClientOptions

required

Returns

MetricsClient

Methods

getActiveUsersMetrics()

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.

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

Parameters

GetActiveUsersMetricsMetricsRequest

required

RequestOptions

Request-specific configuration.

Returns

ActiveUserMetricsResponse

getDauMetrics()

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.

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

Parameters

GetDauMetricsMetricsRequest

required

RequestOptions

Request-specific configuration.

Returns

ActiveUserMetricsListResponse

getMauMetrics()

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.

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

Parameters

GetMauMetricsMetricsRequest

required

RequestOptions

Request-specific configuration.

Returns

ActiveUserMetricsListResponse

getOrganizationUsageMetrics()

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.

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

Parameters

GetOrganizationUsageMetricsMetricsRequest

required

RequestOptions

Request-specific configuration.

Returns

UsageMetrics

getPrMetrics()

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.

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

Parameters

GetPrMetricsMetricsRequest

required

RequestOptions

Request-specific configuration.

Returns

PrMetricsResponse

getSearchMetrics()

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

Get aggregated search metrics for the enterprise account.

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

Parameters

GetSearchMetricsMetricsRequest

required

RequestOptions

Request-specific configuration.

Returns

SearchMetricsResponse

getSessionMetrics()

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.

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

Parameters

GetSessionMetricsMetricsRequest

required

RequestOptions

Request-specific configuration.

Returns

SessionMetricsResponse

getSessionsByCategory()

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

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

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

Parameters

GetSessionsByCategoryMetricsRequest

required

RequestOptions

Request-specific configuration.

Returns

SessionsByCategoryResponse

getUsageMetrics()

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.

await client.enterprise.metrics.getUsageMetrics()

Parameters

GetUsageMetricsMetricsRequest

RequestOptions

Request-specific configuration.

Returns

UsageMetrics

getWauMetrics()

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.

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

Parameters

GetWauMetricsMetricsRequest

required

RequestOptions

Request-specific configuration.

Returns

ActiveUserMetricsListResponse

​Constructor

​Parameters

​Returns

​Methods

​getActiveUsersMetrics()

​Parameters

​Returns

​getDauMetrics()

​Parameters

​Returns

​getMauMetrics()

​Parameters

​Returns

​getOrganizationUsageMetrics()

​Parameters

​Returns

​getPrMetrics()

​Parameters

​Returns

​getSearchMetrics()

​Parameters

​Returns

​getSessionMetrics()

​Parameters

​Returns

​getSessionsByCategory()

​Parameters

​Returns

​getUsageMetrics()

​Parameters

​Returns

​getWauMetrics()

​Parameters

​Returns

Constructor

Parameters

Returns

Methods

getActiveUsersMetrics()

Parameters

Returns

getDauMetrics()

Parameters

Returns

getMauMetrics()

Parameters

Returns

getOrganizationUsageMetrics()

Parameters

Returns

getPrMetrics()

Parameters

Returns

getSearchMetrics()

Parameters

Returns

getSessionMetrics()

Parameters

Returns

getSessionsByCategory()

Parameters

Returns

getUsageMetrics()

Parameters

Returns

getWauMetrics()

Parameters

Returns