コストダッシュボード データを取得する

GET /api/v1/projects/{id}/ コスト/dashball
Bearer 認証

Organization Engine 経由で集計されたコストとトークン使用状況のデータを返します。プロジェクトスコープは ルート ID パス パラメーターによって保持され、 組織はそのプロジェクトから派生します。

path パラメータ

  • id string 必須

    プロジェクトID

クエリ パラメータ

  • period string

    期間（例: 7d、30d、90d）

  • Workspace_id string

    ワークスペースでフィルタリング

応答

  • 406

    サポートされていないAPIバージョンまたは不正な API バージョン、選択した公開契約で利用できない操作、または受け入れができない表現（サポートされていないメディアタイプのパラメーター、または除外された SSE を含む）。既存の認証、認可、およびレート制限の失敗が優先されます。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      標準エラースキーマによって定義される任意の検証の詳細。 APIネゴシエート エラーでは、このフィールドは出力されません。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        検証に失敗したフィールド。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト

        フィールドとその検証の失敗。

        • 説明 string 必須

          人間が判読できる検証の失敗。

        • フィールド string 必須

          無効なリクエストフィールドの名前またはパス。

    • 詳細 string 必須

      人間が判読できるエラーの詳細。

    • エラー integer 必須

      HTTP status code.

    • errorCode string 必須

      マシンが判読できるエラー コード。

    • パラメーター array[string]

      エラーに関連付けられたリクエスト パラメータ名。該当しない場合は省略します。

    • 理由 string 必須

      HTTPステータス理由フレーズ。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      標準エラースキーマによって定義される任意の検証の詳細。 APIネゴシエート エラーでは、このフィールドは出力されません。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        検証に失敗したフィールド。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト

        フィールドとその検証の失敗。

        • 説明 string 必須

          人間が判読できる検証の失敗。

        • フィールド string 必須

          無効なリクエストフィールドの名前またはパス。

    • 詳細 string 必須

      人間が判読できるエラーの詳細。

    • エラー integer 必須

      HTTP status code.

    • errorCode string 必須

      マシンが判読できるエラー コード。

    • パラメーター array[string]

      エラーに関連付けられたリクエスト パラメータ名。該当しない場合は省略します。

    • 理由 string 必須

      HTTPステータス理由フレーズ。
  • 200

    OK

    応答属性の非表示 応答属性の表示 オブジェクト
    • by_model array[オブジェクト]
      by_model 属性を非表示 _model 属性を表示 オブジェクト
      • Call_count integer
      • モデル string
      • パーセント 数値
      • total_ Cost_usd 数値
      • total_tokens integer
    • by_workスペース array[オブジェクト]
      _workスペース属性で非表示 _workスペース属性で表示 オブジェクト
      • Call_count integer
      • パーセント 数値
      • total_ Cost_usd 数値
      • total_tokens integer
      • Workspace_id string
    • daily_trend array[オブジェクト]
      Hide daily_trend attributes daily_trend 属性の表示 オブジェクト
      • Call_count integer
      • date string
      • total_ Cost_usd 数値
      • total_tokens integer
    • 成功 ブール値
    • 概要 オブジェクト
      サマリー属性を非表示にする サマリー属性を表示する オブジェクト
      • total_completed_tokens integer
      • total_ Cost_usd 数値
      • total_llm_cols integer
      • total_prompt_tokens integer
      • total_tokens integer
      • unprice_llm_cols integer
    応答属性の非表示 応答属性の表示 オブジェクト
    • by_model array[オブジェクト]
      by_model 属性を非表示 _model 属性を表示 オブジェクト
      • Call_count integer
      • モデル string
      • パーセント 数値
      • total_ Cost_usd 数値
      • total_tokens integer
    • by_workスペース array[オブジェクト]
      _workスペース属性で非表示 _workスペース属性で表示 オブジェクト
      • Call_count integer
      • パーセント 数値
      • total_ Cost_usd 数値
      • total_tokens integer
      • Workspace_id string
    • daily_trend array[オブジェクト]
      Hide daily_trend attributes daily_trend 属性の表示 オブジェクト
      • Call_count integer
      • date string
      • total_ Cost_usd 数値
      • total_tokens integer
    • 成功 ブール値
    • 概要 オブジェクト
      サマリー属性を非表示にする サマリー属性を表示する オブジェクト
      • total_completed_tokens integer
      • total_ Cost_usd 数値
      • total_llm_cols integer
      • total_prompt_tokens integer
      • total_tokens integer
      • unprice_llm_cols integer
  • 400

    無効なリクエスト

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 401

    許可されていない

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 500

    内部サーバーエラー

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 502

    バード ゲートウェイ

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
GET /api/v1 /projects/{id}/ コスト/dashball 
curl \
 --request GET 'https://agentengine.mongodb.com/api/v1/projects/{id}/cost/dashboard' \
 --header "Authorization: $API_KEY"
応答の例（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"
}
応答の例（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"
}
応答の例（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
  }
}
応答の例（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
  }
}
応答の例（400） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（400） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（401） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（401） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（500） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（500） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（502） 
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例（502） 
{
  "code": "string",
  "error": "string",
  "success": true
}