Chartquery

Uso

Monitorize a quota de subscrição, o pack pontual e os créditos em tempo real.

O endpoint de Uso retorna a cota API restante, créditos, limites de taxa e detalhes da chave de API a qualquer momento. Ele não consome créditos.

Nota: o objeto subscription reflete a cota API combinada (assinatura + packs pontuais restantes), não apenas a parte da assinatura. O painel exibe a divisão Assinatura / Packs pontuais.

Este endpoint é gratuito. Nunca consome créditos.

Requisição

curl "https://api.chartquery.com/v1/usage" \
  -H "x-api-key: YOUR_API_KEY"

Os três saldos

Cada chamada consome de até três saldos, sempre por esta ordem. A resposta detalha cada um separadamente para que saiba de onde vêm os seus créditos.

  • Quota de subscrição (subscription): chamadas incluídas num plano mensal. Reposta a cada período de faturação (period, renewal_date).
  • Pack pontual (packs): packs API pontuais, nunca repostos, consumidos por ordem de compra depois da quota de subscrição. packs.current é o pack em uso agora.
  • Créditos (credits): usados apenas quando quota e packs estão esgotados. Faturados à parte.

remaining é o total ainda disponível nos três saldos e total_used o total consumido. Quando remaining chega a 0, as chamadas devolvem 402 até ser adicionado um pack ou créditos.

Campos de resposta

CampoTipoDescrição
remainingintegerTotal de créditos disponíveis (quota de subscrição + pack pontual + créditos)
total_usedintegerTotal consumido nos três saldos (o uso dos packs persiste entre períodos)
renewal_datestringData de renovação da assinatura (ISO 8601)
period.startstringInício do período de faturação atual
period.endstringFim do período de faturação atual
subscription.usedintegerChamadas API usadas contra a cota API combinada
subscription.totalintegerLimite de cota API combinada (assinatura + packs pontuais)
subscription.remainingintegerCota API combinada restante (parte da assinatura + packs pontuais não usados)
subscription.percent_usednumberPercentual da cota API consumida
credits.givenintegerCréditos concedidos (saldo separado)
credits.consumedintegerCréditos consumidos
credits.remainingintegerCréditos restantes
rate_limit.per_minuteinteger | nullLimite de requisições por minuto (null = ilimitado)
rate_limit.per_secondinteger | nullLimite de requisições por segundo (null = ilimitado)
account.namestringNome da conta
account.slugstringIdentificador da conta
api_key.aliasstringNome amigável da chave de API
api_key.activebooleanSe a chave está atualmente ativa
api_key.categorystringCategoria da chave (ex. development, production)
api_key.expiresstring | nullData de expiração da chave (null = nunca expira)
api_key.quotasobjectCotas personalizadas por chave: total, daily, weekly, monthly
packsobject | nullPacks API pontuais, pack a pack (null se a conta não tiver nenhum). Em contas sem plano mensal, subscription.total é a soma de todos os packs
packs.countintegerNúmero de packs ativos
packs.exhausted_countintegerNúmero de packs totalmente consumidos
packs.totalintegerCréditos concedidos por todos os packs ativos
packs.usedintegerCréditos consumidos em todos os packs
packs.remainingintegerCréditos restantes em todos os packs
packs.currentobject | nullO pack em consumo (os packs são usados por ordem de compra); null quando todos estão esgotados
packs.items[]object[]Cada pack ativo: id, title, purchased_at, total, used, remaining, percent_used, exhausted

Exemplo de resposta

{
  "remaining": 450,
  "total_used": 1550,
  "renewal_date": "2026-04-25",
  "period": {
    "start": "2026-03-25",
    "end": "2026-04-25"
  },
  "subscription": {
    "used": 1550,
    "total": 2000,
    "remaining": 450,
    "percent_used": 77
  },
  "packs": {
    "count": 2,
    "exhausted_count": 1,
    "all_exhausted": false,
    "total": 25000000,
    "used": 15200000,
    "remaining": 9800000,
    "percent_used": 60.8,
    "current_index": 2,
    "current": {
      "id": "cm…",
      "title": "Ultimate",
      "purchased_at": "2026-02-07",
      "total": 12500000,
      "used": 2700000,
      "remaining": 9800000,
      "percent_used": 21.6,
      "exhausted": false
    },
    "items": [
      { "id": "cm…", "title": "Ultimate", "purchased_at": "2025-11-10", "total": 12500000, "used": 12500000, "remaining": 0, "percent_used": 100, "exhausted": true },
      { "id": "cm…", "title": "Ultimate", "purchased_at": "2026-02-07", "total": 12500000, "used": 2700000, "remaining": 9800000, "percent_used": 21.6, "exhausted": false }
    ]
  },
  "credits": {
    "given": 0,
    "consumed": 0,
    "remaining": 0,
    "percent_used": 0
  },
  "rate_limit": {
    "per_minute": null,
    "per_second": null
  },
  "account": {
    "name": "Acme Corp",
    "slug": "acme-corp"
  },
  "api_key": {
    "alias": "production",
    "active": true,
    "category": "production",
    "expires": null,
    "quotas": {
      "total": null,
      "daily": null,
      "weekly": null,
      "monthly": null
    }
  }
}

Veja também: Stats para a saúde de infraestrutura da plataforma na última hora. Não é o uso da sua conta.

Nesta página