Athena
Home
Environments
Environments
  • Development Server
  • Production
Home
Environments
Environments
  • Development Server
  • Production
  1. Metrics
  • Getting Started
    • Start Guide
  • Installation & Setup
    • Windows
  • Architecture
  • Guide
    • Bundles
      • Backend
    • Permissions
      • Frontend
    • Developers
      • Commit Lint
      • RESTful API
    • Workflows
      • Workflow Variables
  • API Reference
    • Authentication
      • Sign In
      • Logout
    • User
      • Get Authenticated User using Multiplai App Access Token
      • Get Authenticated User using Basic Token
    • Workspace
      • Get Workspaces Metrics
      • Get Workspaces
      • Update a Workspace
      • Retrieve a workspace
      • Delete a Workspace
    • Provider
      • Get Providers
      • Retrieve a Provider
      • Update a Provider
      • Create a Provider
      • Delete a Provider
    • Account
      • Get Accounts
      • Update an Account
      • Create an Account
      • Delete an Account
      • Retrieve an Account
    • Agent
      • Get Agents
      • Update an Agent
      • Create an Agent
      • Delete an Agent
      • Retrieve an Agent
      • Run an Agent
      • Train an Agent
      • Generate an Agent
      • Share Agent
      • Get Agent Leaderboard
    • Workflow
      • Get Workflows
      • Create a Workflow
      • Retrieve a Workflow
      • Update a Workflow
      • Delete a Workflow
      • Trigger a webhook
      • Share Workflow
      • Generate Workflow
    • Workflow Execution
      • Get Workflow Executions
      • Get Workflow Execution Counts
      • Retrieve a Workflow Execution
      • Delete a Workflow Execution
    • Prompt
      • Get Prompts
      • Create a Prompt
      • Retrieve a Prompt
      • Update a Prompt
      • Delete a Prompt
      • Run a prompt
    • Memory
      • Get Memories
      • Retrieve a Memory
      • Update a Memory
      • Delete a Memory
    • Thread
      • Get Threads
      • Retrieve a Thread
      • Update a Thread
      • Delete a Thread
      • Create a Thread
      • Run a Thread
      • Generate Thread Name
    • Message
      • Get Messages
      • Retrieve a Message
      • Update a Message
      • Delete a Message
      • Create a Message
    • Large Language Model
      • Get Large Language Models
      • Retrieve a Large Language Model
    • Command Room Task
      • Store Command Room Task
      • Remove Command Room Task
    • Metrics
      • Get Agents Metrics
        POST
      • Get Workflows Metrics
        POST
      • Get Threads Metrics
        POST
      • Get Messages Metrics
        POST
      • Get Workflow Executions Metrics
        POST
  • Schemas
    • Resources
      • User
      • Workspace
      • Provider
      • Account
      • Agent
      • Workflow
      • Share
      • WorkflowExecution
      • WorkflowExecutionData
      • Prompt
      • Memory
      • Thread
      • Attachment
      • Media
      • Tool
      • Message
      • LargeLanguageModel
      • AgentLeaderboard
    • Utils
      • Pagination
        • PaginationMeta
        • PaginationLinks
      • Provider
        • AuthenticationConfig
      • Profile
        • ProfilePhotoConfig
      • Workflow
        • WorkflowExecutionDataWorkflowData
        • Node
        • Edge
  1. Metrics

Get Threads Metrics

Local
https://localhost
Local
https://localhost
POST
/api/v1/threads/metrics

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Header Params

Body Params application/x-www-form-urlencoded

Responses

🟢200Success
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://localhost/api/v1/threads/metrics' \
--header 'Accept: application/json' \
--header 'X-Multiplai-Authorization;' \
--header 'Authorization: Bearer <token>' \
--data-urlencode 'calculation=The type of metric calculation to perform. Options: accumulated_count time_series_count accumulated_average time_series_average' \
--data-urlencode 'column=The column to use for calculations. Required for average calculations (accumulated_average or time_series_average) and cannot be '\''*'\''. Max 255 characters' \
--data-urlencode 'granularity=Time grouping for time series calculations. Required when calculation is time_series_count or time_series_average. Options: daily weekly monthly' \
--data-urlencode 'date_from=Start date for filtering results (valid date format)' \
--data-urlencode 'date_to=End date for filtering results. Must be after or equal to date_from (valid date format)' \
--data-urlencode 'workspace_uuid=Filter threads by workspace UUID (valid UUID format)' \
--data-urlencode 'user_id=Filter threads by a single user ID' \
--data-urlencode 'user_ids=Filter threads by multiple user IDs (array of integers)' \
--data-urlencode 'user_multiplai_id=Filter threads by a single Multiplai user ID' \
--data-urlencode 'user_multiplai_ids=Filter threads by multiple Multiplai user IDs (array of integers)' \
--data-urlencode 'search=Search threads by name or description' \
--data-urlencode 'agent_uuid=Filter threads by agent UUID (valid UUID format)'
Response Response Example
{
    "resource_type": "Agent",
    "calculation": "accumulated_count",
    "column": "string",
    "total": 0,
    "data": [
        {
            "value": 0,
            "count": 0
        }
    ],
    "granularity": "daily",
    "period_from": "2019-08-24T14:15:22.123Z",
    "period_to": "2019-08-24T14:15:22.123Z",
    "cached_at": "2019-08-24T14:15:22.123Z"
}
Modified at 2026-02-04 08:21:07
Previous
Get Workflows Metrics
Next
Get Messages Metrics
Built with