---
title: "Get workspace analytics"
method: GET
path: "/v1/analytics/{metric}"
tags: ["V1 - Analytics"]
---

# Get workspace analytics

`GET /v1/analytics/{metric}`

## Request

- Base URL: `https://api.app.noxus.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.app.noxus.ai/v1/analytics/{metric}`
- Auth: API key in header `X-API-Key`

Query analytics metrics for the workspace associated with the API key. Results are scoped to the workspace and time range provided.

## Path parameters

- `metric` 'flow_runs' | 'trigger_runs' | 'manual_runs' | 'agent_runs' | 'active_users' | 'active_runs' | 'active_triggers' | 'errors' | 'average_run_time' | 'flow_runs_distribution' | 'flow_per_user' | 'errors_over_time' | 'run_time_over_time' | 'ai_models_total_cost' | 'ai_models_total_tokens' | 'average_cost_per_run' | 'tokens_cost' | 'tokens_cost_by_workflow' | 'tokens_cost_by_user' | 'model_tokens_total_cost' | 'ai_operations_per_tool' | 'model_tokens_per_tool' | 'ai_operations_per_user' | 'model_tokens_per_user' | 'conversations_started' | 'messages_sent' | 'messages_per_conversation' | 'conversation_users' | 'conversations_started_over_time' | 'messages_sent_over_time' | 'conversations_started_by_user' | 'messages_sent_by_user' | 'conversation_tokens_cost' | 'conversation_tokens_cost_by_user' | 'conversation_chat_costs_total' | 'api_calls_per_date' | 'api_calls_per_endpoint' | 'api_calls_log' | 'kb_total_documents' | 'kb_processed_successfully' | 'kb_contributors' | 'kb_failed_documents' | 'kb_documents_over_time' | 'kb_documents_per_kb' | 'kb_documents_by_user' | 'kb_document_types' | 'kb_user_activity' | 'kb_overview', required: Analytics metrics available via the public API. Excludes billing-constraint overage keys, cross-workspace/tenant aggregates, infrastructure/worker metrics, internal labelling-system keys, and workflow-scoped keys that need a flow id this surface does not take.

## Query parameters

- `time_start` string, date-time, required: Start of the time range (ISO 8601 with timezone)
- `time_end` string, date-time, required: End of the time range (ISO 8601 with timezone)
- `page` integer, nullable: Page number for paginated metrics
- `page_size` integer, nullable: Page size for paginated metrics (default 50, max 200)

## Response `200`

Successful Response

- AnalyticsResponse
  - `type` 'simple' | 'barchart' | 'table' | 'horizontal-barchart' | 'empty', required
  - `value` union, required
    - AnalyticsSimpleValue
      - `value` union, required
        - string
        - integer
        - number
      - `suffix` string, nullable
      - `prefix` string, nullable
      - `currency` 'USD' | 'EUR' | 'GBP', nullable: Set when value is an amount of money in this currency
      - `cost_details` AnalyticsCostValue
        - `value` number, required
        - `estimated_additional_cost` number, required
        - `estimated_in_progress_cost` number, required
        - `estimated_interrupted_cost` number, required
        - `estimated_other_cost` number, required
        - `message` string, required
        - `currency` 'USD' | 'EUR' | 'GBP', required: Currency of every amount in this value, already converted
        - `currency_note` string, nullable
    - AnalyticsBarChartsValue
      - `values` AnalyticsBarChartValue[], required
        - `name` string, required
        - `values` object, required
        - `value_mapping` object, nullable
    - AnalyticsTableValue
      - `headings` string[], required
      - `rows` object[], required
      - `prefixes` object, nullable
      - `suffixes` object, nullable
    - AnalyticsPaginatedTableValue
      - `headings` string[], required
      - `items` object[], required
      - `prefixes` object, nullable
      - `suffixes` object, nullable
      - `total` integer, required
      - `pages` integer, required
      - `size` integer, required
      - `page` integer, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/noxus/apis/noxus-backend.md) - [All operations](https://skmtc.dev/noxus/apis/noxus-backend/llms.txt) - [OpenAPI document](https://skmtc.dev/noxus/apis/noxus-backend/revisions/0e37810b7ad5?raw)