API de AnalyticsEndpoints

Devuelve el uso en tiempo real de la cuota de la API de la empresa autenticada

Devuelve el uso y los límites actuales de la cuota de la empresa — una entrada por ventana de cuota, como por minuto o por día. Todas las API keys de la empresa comparten esta cuota. Usa este endpoint para autolimitar tu ritmo antes de hacer solicitudes de analítica costosas. Notas: - Cuando una métrica no tiene tope, la respuesta devuelve `limit: null` y `remaining: null` para que no dividas por cero. - Cuando la empresa no tiene cuota, `quotas` es una lista vacía. - Una sola solicitud a la API puede contar como más de una consulta contra `max_queries_per_minute`, así que el contador `queries` puede subir más rápido que tu ritmo de solicitudes. La respuesta incluye `queries.note` para señalarlo cuando se aplica un límite estricto. `read_bytes` refleja los datos realmente escaneados y es la señal más fiable para dimensionar el uso. - Este endpoint cuenta en sí mismo como 1 consulta contra `max_queries_per_minute`.

GET
/quota/usage

Authorization

apiToken apiVersion userAgent
X-Api-Token<token>

Accede a la aplicación y copia tu token de API; luego, solo tienes que definir el encabezado X-Api-Token con él.

In: header

X-Api-Version<token>

La versión de la API que se usará. Las versiones compatibles actualmente son:

  • v1: La versión estable actual

Una solicitud sin este encabezado, o con cualquier otro valor, la responde el edge con 404 y {"error_msg":"404 Route Not Found"}.

In: header

User-Agent<token>

Se requiere un User-Agent no vacío que identifique tu integración. Las solicitudes sin él se rechazan en el edge antes de llegar a la API.

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/quota/usage"
{  "quotas": [    {      "interval_seconds": 60,      "interval_starts_at": "2026-04-27T12:34:00Z",      "interval_ends_at": "2026-04-27T12:35:00Z",      "queries": {        "used": 20,        "limit": 60,        "remaining": 40,        "note": "a single API request may count as more than one query against this limit"      },      "read_bytes": {        "used": 92535478,        "limit": null,        "remaining": null      }    },    {      "interval_seconds": 86400,      "interval_starts_at": "2026-04-27T00:00:00Z",      "interval_ends_at": "2026-04-28T00:00:00Z",      "queries": {        "used": 245,        "limit": null,        "remaining": null      },      "read_bytes": {        "used": 4500000000,        "limit": 343597383680,        "remaining": 339097383680      }    }  ]}