Uso de contrato

Referencia tecnica del endpoint Uso de contrato.

Quickstart Auth Errores

Descripcion

Agrega eventos de uso por contrato y periodo. Se puede agrupar por dia, hora, metric o unit.

Endpoint

Metodo: GET
Path: /api/v1/contracts/{id}/usage

Query params

start (ISO 8601, requerido)
end (ISO 8601, requerido)
group_by: day | hour | metric | unit
page, per_page

Respuestas

200: uso agregado
400: parametros invalidos
404: contrato no encontrado

Request

curl -X GET '$BASE/api/v1/contracts/123/usage?start=2026-02-01T00:00:00Z&end=2026-02-10T23:59:59Z&group_by=day' \
  -H 'Authorization: Bearer $TOKEN'

curl -X GET '$BASE/api/v1/contracts/123/usage?start=2026-02-01T00:00:00Z&end=2026-02-10T23:59:59Z&group_by=day' \
  -H 'Authorization: Bearer $TOKEN'

Response

{
  "contractId":123,
  "start":"2026-02-01T00:00:00Z",
  "end":"2026-02-10T23:59:59Z",
  "data":[{"bucket":"2026-02-10","metric":"API_CALL","unit":"api_calls","quantity":150}],
  "pagination":{"page":1,"per_page":50,"total":1}
}

{
  "contractId":123,
  "start":"2026-02-01T00:00:00Z",
  "end":"2026-02-10T23:59:59Z",
  "data":[{"bucket":"2026-02-10","metric":"API_CALL","unit":"api_calls","quantity":150}],
  "pagination":{"page":1,"per_page":50,"total":1}
}