Saltar para o conteúdo
CargoDuo logoCargoDuo
Preços
Entrar

Por enquanto, esta documentação está disponível só em inglês.

Get usage

Requests, jobs, credits, compute seconds and vehicles per UTC day.

GEThttps://runner.cargoduo.com/v1/usage

Without from/to: the last 30 days. At most 92 days per call.

Autenticação

Chave de API Bearer com a permissãoaccount:readSaber mais

Parâmetros de consulta

NomeTipoObrigatórioDescrição
fromstring
string
Não

First day, YYYY-MM-DD (UTC).

tostring
string
Não

Last day, YYYY-MM-DD (UTC). Defaults to today.

Exemplo de pedido

curl -X GET "https://runner.cargoduo.com/v1/usage?from=2026-10-17&to=2026-10-19" \
  -H "Authorization: Bearer $CARGODUO_API_KEY"

Exemplo de resposta

200 OK · Usage
{
  "data": [
    {
      "date": "2026-10-17",
      "requests": 41,
      "jobs": 9,
      "credits": 2.931,
      "compute_seconds": 38.2,
      "vehicles": 11
    },
    {
      "date": "2026-10-18",
      "requests": 12,
      "jobs": 3,
      "credits": 0.829,
      "compute_seconds": 9.8,
      "vehicles": 3
    },
    {
      "date": "2026-10-19",
      "requests": 27,
      "jobs": 6,
      "credits": 1.867,
      "compute_seconds": 21.4,
      "vehicles": 7
    }
  ]
}

Respostas

  • 200OKOne row per day.
    NomeTipoObrigatórioDescrição
    dataUsageDay[]
    UsageDay[]
    Não
  • 401Unauthorizedunauthorizedkey_revokedkey_expired
    • unauthorizedMissing, malformed or unknown API key.
    • key_revokedThe key was revoked.
    • key_expiredThe key passed its expiry date.
    NomeTipoObrigatórioDescrição
    errorErrorBodyobrigatório
    ErrorBody
    Sim
    Todos os códigos de erro
  • 403Forbiddenip_not_allowedsubscription_inactiveaccount_inactivescope_missing
    • ip_not_allowedThe calling IP is not on the key's allowlist.
    • subscription_inactiveThe organization has no active subscription that includes the API.
    • account_inactiveThe organization is suspended, or has no owner whose account is active.
    • scope_missingThe key lacks a scope this endpoint needs.
    NomeTipoObrigatórioDescrição
    errorErrorBodyobrigatório
    ErrorBody
    Sim
    Todos os códigos de erro
  • 422Unprocessable entityvalidation_failed
    • validation_failedThe request is well-formed JSON but describes an invalid job. details[] lists every problem.
    NomeTipoObrigatórioDescrição
    errorErrorBodyobrigatório
    ErrorBody
    Sim
    Todos os códigos de erro
  • 429Too many requestsrate_limited
    • rate_limitedToo many requests in the current minute, hour or day (per key or per organization), or more than 60 failed authentications per minute from your IP address.
    NomeTipoObrigatórioDescrição
    errorErrorBodyobrigatório
    ErrorBody
    Sim
    Todos os códigos de erro
  • 500Internal server errorinternal_error
    • internal_errorSomething failed on our side.
    NomeTipoObrigatórioDescrição
    errorErrorBodyobrigatório
    ErrorBody
    Sim
    Todos os códigos de erro
  • 503Service unavailableapi_disabled
    • api_disabledThe API is temporarily disabled (maintenance) or switched off for the organization.
    NomeTipoObrigatórioDescrição
    errorErrorBodyobrigatório
    ErrorBody
    Sim
    Todos os códigos de erro