Get cost dashboard data

GET /api/v1/projects/{id}/cost/dashboard
Bearer auth

Returns aggregated cost and token usage data via the Orchestration Engine. The project scope is carried by the route id path parameter and the org is derived from that project.

Path parameters

  • id string Required

    Project ID

Query parameters

  • period string

    Time period (e.g. 7d, 30d, 90d)

  • workspace_id string

    Filter by workspace

Responses

  • 406

    Unsupported or malformed API version, an operation unavailable in the selected published contract, or an unacceptable representation (including unsupported media-type parameters or excluded SSE). Existing authentication, authorization, and rate-limit failures take precedence.

    Hide response attributes Show response attributes object
    • badRequestDetail object

      Optional validation details defined by the standard error schema; API negotiation errors do not emit this field.

      Hide badRequestDetail attribute Show badRequestDetail attribute object
      • fields array[object]

        Fields with validation failures.

        Hide fields attributes Show fields attributes object

        A field and its validation failure.

        • description string Required

          Human-readable validation failure.

        • field string Required

          Name or path of the invalid request field.

    • detail string Required

      Human-readable error details.

    • error integer Required

      HTTP status code.

    • errorCode string Required

      Machine-readable error code.

    • parameters array[string]

      Request parameter names associated with the error; omitted when none apply.

    • reason string Required

      HTTP status reason phrase.

    Hide response attributes Show response attributes object
    • badRequestDetail object

      Optional validation details defined by the standard error schema; API negotiation errors do not emit this field.

      Hide badRequestDetail attribute Show badRequestDetail attribute object
      • fields array[object]

        Fields with validation failures.

        Hide fields attributes Show fields attributes object

        A field and its validation failure.

        • description string Required

          Human-readable validation failure.

        • field string Required

          Name or path of the invalid request field.

    • detail string Required

      Human-readable error details.

    • error integer Required

      HTTP status code.

    • errorCode string Required

      Machine-readable error code.

    • parameters array[string]

      Request parameter names associated with the error; omitted when none apply.

    • reason string Required

      HTTP status reason phrase.
  • 200

    OK

    Hide response attributes Show response attributes object
    • by_model array[object]
      Hide by_model attributes Show by_model attributes object
      • call_count integer
      • model string
      • percentage number
      • total_cost_usd number
      • total_tokens integer
    • by_workspace array[object]
      Hide by_workspace attributes Show by_workspace attributes object
      • call_count integer
      • percentage number
      • total_cost_usd number
      • total_tokens integer
      • workspace_id string
    • daily_trend array[object]
      Hide daily_trend attributes Show daily_trend attributes object
      • call_count integer
      • date string
      • total_cost_usd number
      • total_tokens integer
    • success boolean
    • summary object
      Hide summary attributes Show summary attributes object
      • total_completion_tokens integer
      • total_cost_usd number
      • total_llm_calls integer
      • total_prompt_tokens integer
      • total_tokens integer
      • unpriced_llm_calls integer
    Hide response attributes Show response attributes object
    • by_model array[object]
      Hide by_model attributes Show by_model attributes object
      • call_count integer
      • model string
      • percentage number
      • total_cost_usd number
      • total_tokens integer
    • by_workspace array[object]
      Hide by_workspace attributes Show by_workspace attributes object
      • call_count integer
      • percentage number
      • total_cost_usd number
      • total_tokens integer
      • workspace_id string
    • daily_trend array[object]
      Hide daily_trend attributes Show daily_trend attributes object
      • call_count integer
      • date string
      • total_cost_usd number
      • total_tokens integer
    • success boolean
    • summary object
      Hide summary attributes Show summary attributes object
      • total_completion_tokens integer
      • total_cost_usd number
      • total_llm_calls integer
      • total_prompt_tokens integer
      • total_tokens integer
      • unpriced_llm_calls integer
  • 400

    Bad Request

    Hide response attributes Show response attributes object
    • code string
    • error string
    • success boolean
    Hide response attributes Show response attributes object
    • code string
    • error string
    • success boolean
  • 401

    Unauthorized

    Hide response attributes Show response attributes object
    • code string
    • error string
    • success boolean
    Hide response attributes Show response attributes object
    • code string
    • error string
    • success boolean
  • 500

    Internal Server Error

    Hide response attributes Show response attributes object
    • code string
    • error string
    • success boolean
    Hide response attributes Show response attributes object
    • code string
    • error string
    • success boolean
  • 502

    Bad Gateway

    Hide response attributes Show response attributes object
    • code string
    • error string
    • success boolean
    Hide response attributes Show response attributes object
    • code string
    • error string
    • success boolean
GET /api/v1/projects/{id}/cost/dashboard 
curl \
 --request GET 'https://agentengine.mongodb.com/api/v1/projects/{id}/cost/dashboard' \
 --header "Authorization: $API_KEY"
Response examples (406) 
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "This operation supports text/event-stream, which the Accept header excludes. Remove unsupported media-type parameters or accept this type with a positive q value.",
  "error": 406,
  "errorCode": "UNACCEPTABLE_MEDIA_TYPE",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "The requested API version is not supported. Supported versions: 2026-09-20-preview.",
  "error": 406,
  "errorCode": "UNSUPPORTED_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
Response examples (406) 
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
Response examples (200) 
{
  "by_model": [
    {
      "call_count": 42,
      "model": "string",
      "percentage": 42.0,
      "total_cost_usd": 42.0,
      "total_tokens": 42
    }
  ],
  "by_workspace": [
    {
      "call_count": 42,
      "percentage": 42.0,
      "total_cost_usd": 42.0,
      "total_tokens": 42,
      "workspace_id": "string"
    }
  ],
  "daily_trend": [
    {
      "call_count": 42,
      "date": "string",
      "total_cost_usd": 42.0,
      "total_tokens": 42
    }
  ],
  "success": true,
  "summary": {
    "total_completion_tokens": 42,
    "total_cost_usd": 42.0,
    "total_llm_calls": 42,
    "total_prompt_tokens": 42,
    "total_tokens": 42,
    "unpriced_llm_calls": 42
  }
}
Response examples (200) 
{
  "by_model": [
    {
      "call_count": 42,
      "model": "string",
      "percentage": 42.0,
      "total_cost_usd": 42.0,
      "total_tokens": 42
    }
  ],
  "by_workspace": [
    {
      "call_count": 42,
      "percentage": 42.0,
      "total_cost_usd": 42.0,
      "total_tokens": 42,
      "workspace_id": "string"
    }
  ],
  "daily_trend": [
    {
      "call_count": 42,
      "date": "string",
      "total_cost_usd": 42.0,
      "total_tokens": 42
    }
  ],
  "success": true,
  "summary": {
    "total_completion_tokens": 42,
    "total_cost_usd": 42.0,
    "total_llm_calls": 42,
    "total_prompt_tokens": 42,
    "total_tokens": 42,
    "unpriced_llm_calls": 42
  }
}
Response examples (400) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Response examples (400) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Response examples (401) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Response examples (401) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Response examples (500) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Response examples (500) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Response examples (502) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Response examples (502) 
{
  "code": "string",
  "error": "string",
  "success": true
}