GET /api/teams/{teamId}/mail/api-keys/{keyId}/usage
Uso agregado por hora dessa chave
- Access: Team admin
- Service:
https://mail-api.axuz.net
Accepted authentication
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.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
teamId | path | string | yes | |
keyId | path | string | yes | |
from | query | string | no | RFC3339. Default |
to | query | string | no | RFC3339. Default |
Responses
200
Buckets by hour (from/to em RFC3339; default 24h)
| Name | Type | Required | Description |
|---|---|---|---|
items | array<MailUsageBucket> | yes | |
items[].bucket | string<date-time> | yes | |
items[].count | integer | yes | |
items[].success | integer | yes | Chamadas com status 2xx |
items[].failure | integer | yes | Chamadas com status >= 400 (exclui 503 §37.15 quando não conta) |
from | string<date-time> | yes | |
to | string<date-time> | yes |
401
Sem credencial valida
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
403
Não é owner/admin
404
Chave não achada nesse team
429
Limite de requisições excedido.
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
500
Erro interno. Tente de novo com backoff; reporte o X-Request-Id.
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
Examples
"Try it" is turned off in this reference. Use the examples with your test credential.
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())