Obter dados do painel de custos

OBTER /api/v1/projects/{id}/cost/dashboard
Autenticação do portador

Retorna dados agregados de custo e uso de token por meio do Mecanismo de orquestração. O escopo do projeto é realizado pelo parâmetro route id path e a organização é derivada desse projeto.

parâmetros de caminho

  • id string Obrigatório

    ID do Projeto

parâmetros de query

  • período string

    Período de tempo (por exemplo, 7d, 30d, 90d)

  • workspace_id string

    Filtrar por espaço de trabalho

Respostas

  • 406

    Versão de API não permitida ou malformada, uma operação indisponível no contrato publicado selecionado ou uma representação inaceitável (incluindo parâmetros de tipo de mídia não suportados ou SSE excluído). Falhas existentes de autenticação, autorização e limite de taxa têm precedência.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes de validação opcionais definidos pelo esquema de erro padrão; Os erros de negociação da API não emitem este campo.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Campos com falhas de validação.

        Ocultar atributos de campos Mostrar atributos dos campos objeto

        Um campo e sua falha de validação.

        • Descrição string Obrigatório

          Falha na validação legível por humanos.

        • Campo string Obrigatório

          Nome ou caminho do campo de solicitação inválido .

    • detalhe string Obrigatório

      Detalhes de erro legíveis por humanos.

    • Erro inteiro Obrigatório

      HTTP status code.

    • Código de erro string Obrigatório

      Código de erro legível por máquina.

    • Parâmetros array[string]

      Solicitar nomes de parâmetros associados ao erro; omitido quando nenhum se aplica.

    • Razão string Obrigatório

      Frase de razão do status HTTP.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes de validação opcionais definidos pelo esquema de erro padrão; Os erros de negociação da API não emitem este campo.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Campos com falhas de validação.

        Ocultar atributos de campos Mostrar atributos dos campos objeto

        Um campo e sua falha de validação.

        • Descrição string Obrigatório

          Falha na validação legível por humanos.

        • Campo string Obrigatório

          Nome ou caminho do campo de solicitação inválido .

    • detalhe string Obrigatório

      Detalhes de erro legíveis por humanos.

    • Erro inteiro Obrigatório

      HTTP status code.

    • Código de erro string Obrigatório

      Código de erro legível por máquina.

    • Parâmetros array[string]

      Solicitar nomes de parâmetros associados ao erro; omitido quando nenhum se aplica.

    • Razão string Obrigatório

      Frase de razão do status HTTP.
  • 200

    OK

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • by_model array[objeto]
      Ocultar atributos by_model Mostrar atributos by_model objeto
      • call_count inteiro
      • Modelo string
      • percentagem número
      • total_cost_usd número
      • total_tokens inteiro
    • by_workspace array[objeto]
      Ocultar atributos by_workspace Mostrar atributos by_workspace objeto
      • call_count inteiro
      • percentagem número
      • total_cost_usd número
      • total_tokens inteiro
      • workspace_id string
    • daily_trend array[objeto]
      Hide daily_trend attributes Mostrar atributos daily_trend objeto
      • call_count inteiro
      • data string
      • total_cost_usd número
      • total_tokens inteiro
    • Sucesso booleano
    • Resumo objeto
      Ocultar atributos de resumo Mostrar atributos de resumo objeto
      • total_completion_tokens inteiro
      • total_cost_usd número
      • total_llm_calls inteiro
      • total_prompt_tokens inteiro
      • total_tokens inteiro
      • unpriced_llm_calls inteiro
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • by_model array[objeto]
      Ocultar atributos by_model Mostrar atributos by_model objeto
      • call_count inteiro
      • Modelo string
      • percentagem número
      • total_cost_usd número
      • total_tokens inteiro
    • by_workspace array[objeto]
      Ocultar atributos by_workspace Mostrar atributos by_workspace objeto
      • call_count inteiro
      • percentagem número
      • total_cost_usd número
      • total_tokens inteiro
      • workspace_id string
    • daily_trend array[objeto]
      Hide daily_trend attributes Mostrar atributos daily_trend objeto
      • call_count inteiro
      • data string
      • total_cost_usd número
      • total_tokens inteiro
    • Sucesso booleano
    • Resumo objeto
      Ocultar atributos de resumo Mostrar atributos de resumo objeto
      • total_completion_tokens inteiro
      • total_cost_usd número
      • total_llm_calls inteiro
      • total_prompt_tokens inteiro
      • total_tokens inteiro
      • unpriced_llm_calls inteiro
  • 400

    Solicitação inválida

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • 401

    Não autorizado

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • 500

    Erro interno do servidor

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
  • 502

    Gateway incorreto

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
GET /api/v1/projects/{id}/cost/dashboard 
curl \
 --request GET 'https://agentengine.mongodb.com/api/v1/projects/{id}/cost/dashboard' \
 --header "Authorization: $API_KEY"
Exemplos de resposta (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"
}
Exemplos de resposta (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"
}
Exemplos de resposta (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
  }
}
Exemplos de resposta (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
  }
}
Exemplos de resposta (400) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (400) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (401) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (401) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (500) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (500) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (502) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (502) 
{
  "code": "string",
  "error": "string",
  "success": true
}