Axuz Developers

GET /api/teams/{teamId}/mail/api-keys/{keyId}/usage

Uso agregado por hora dessa chave

  • Acesso: Admin da equipe
  • Serviço: https://mail-api.axuz.net

Autenticação aceita

  • sessionCookie — Sessão plena Axuz (cookie de sessão da casa). Sessão restrita é 403 enrollment_required.
  • bearerSession — JWT de acesso da sessão em `Authorization: Bearer`.

— GET /api/teams/:teamId/mail/api-keys/:keyId/usage. Agregação por hora no range from..to (default 24h). Motivo: mostrar gráfico de uso por chave no admin. Comportamento: verifica que a chave pertence ao team (defesa em profundidade sobre requireTeamAdmin), delega ao aggregateUsage. 404 se chave não achada; 500 se query falha.

Parâmetros

NomeEmTipoObrigatórioDescrição
teamIdpathstringsim
keyIdpathstringsim
fromquerystringnão

RFC3339. Default now - 24h.

toquerystringnão

RFC3339. Default now.

Respostas

200

Buckets by hour (from/to em RFC3339; default 24h)

NomeTipoObrigatórioDescrição
itemsarray<MailUsageBucket>sim
items[].bucketstring<date-time>sim
items[].countintegersim
items[].successintegersim

Chamadas com status 2xx

items[].failureintegersim

Chamadas com status >= 400 (exclui 503 §37.15 quando não conta)

fromstring<date-time>sim
tostring<date-time>sim

401

Sem credencial valida

NomeTipoObrigatórioDescrição
errorstringsim

403

Não é owner/admin

404

Chave não achada nesse team

429

Limite de requisições excedido.

NomeTipoObrigatórioDescrição
errorstringsim

500

Erro interno. Tente de novo com backoff; reporte o X-Request-Id.

NomeTipoObrigatórioDescrição
errorstringsim

Exemplos

O "Try it" está desligado nesta referência. Use os exemplos com a sua credencial de teste.

curl

curl -sS -X GET 'https://mail-api.axuz.net/api/teams/TEAM_ID/mail/api-keys/KEY_ID/usage' \
  -H "Authorization: Bearer $AXUZ_TOKEN"

Node.js

const res = await fetch("https://mail-api.axuz.net/api/teams/TEAM_ID/mail/api-keys/KEY_ID/usage", {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
  },
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
console.log(await res.json());

Python

import os
import requests

res = requests.request(
    "GET",
    "https://mail-api.axuz.net/api/teams/TEAM_ID/mail/api-keys/KEY_ID/usage",
    headers={
        "Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
    },
    timeout=30,
)
res.raise_for_status()
print(res.json())