GET

Endpoint /api/usage

URL

https://api.integrationit.co/api/usage

Descripción

Este endpoint proporciona información sobre el uso actual del servicio, incluyendo el número de sesiones consumidas en el mes en curso, el límite del plan contratado y el porcentaje de uso.

Autenticación

Requiere el header x-api-key con una API key válida.

Parámetros

Este endpoint no requiere parámetros adicionales.

Respuesta

La respuesta incluye información detallada sobre el uso actual:

{
  "company": {
    "name": "Nombre de la empresa"
  },
  "plan": {
    "name": "Nombre del plan",
    "max_sessions": "Cantidad máxima de sesiones permitidas"
  },
  "usage": {
    "current_month_sessions": "Cantidad de sesiones consumidas en el mes actual",
    "percentage": "Porcentaje de uso actual",
    "remaining_sessions": "Cantidad de sesiones restantes"
  },
  "period": {
    "start_date": "Fecha de inicio del periodo",
    "end_date": "Fecha de fin del periodo (puede ser null si el periodo no ha finalizado)"
  }
}

Ejemplos

curl -X GET https://api.integrationit.co/api/usage \
  -H "x-api-key: SU_API_KEY_AQUI"

// Usando fetch
const response = await fetch('https://api.integrationit.co/api/usage', {
  method: 'GET',
  headers: {
    'x-api-key': 'SU_API_KEY_AQUI'
  }
});

const data = await response.json();
console.log(data);

import requests

url = "https://api.integrationit.co/api/usage"
headers = {
    "x-api-key": "SU_API_KEY_AQUI"
}

response = requests.get(url, headers=headers)
print(response.json())

Notas adicionales

El contador de sesiones se reinicia al comienzo de cada mes.
Una "sesión" se define como cada interacción con el endpoint /api/conectia.
El campo status puede tener los valores: "active", "warning" (cuando se ha alcanzado el 80% del límite) o "exceeded" (cuando se ha superado el límite).
Para obtener un historial de uso por períodos, utilice el endpoint /api/usage-history.