GET

Endpoint /api/usage-history

URL

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

Descripción

Este endpoint proporciona un historial detallado del uso del servicio durante un período específico. Permite consultar el número de sesiones consumidas por mes o por rango de fechas personalizado.

Autenticación

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

Parámetros

startDate(string (YYYY-MM-DD))

Fecha de inicio para el período de consulta. Si no se especifica, se utilizará el primer día del año actual.

endDate(string (YYYY-MM-DD))

Fecha de fin para el período de consulta. Si no se especifica, se utilizará la fecha actual.

period(string (day|week|month|year))

Agrupar resultados por día, semana, mes o año. Por defecto: month.

Respuesta

La respuesta incluye un historial detallado del uso por períodos:

{
  "company": {
    "name": "Nombre de la empresa"
  },
  "plan": {
    "name": "Nombre del plan",
    "max_sessions": "Cantidad máxima de sesiones permitidas"
  },
  "query": {
    "period": "month",
    "startDate": "Fecha de inicio del período",
    "endDate": "Fecha de fin del período"
  },
  "stats": {
    "total_sessions": "Cantidad total de sesiones consumidas",
    "avg_sessions_per_period": "Promedio de sesiones consumidas por período",
    "periods_count": 2
  },
  "history": [
    {
      "period": "2025-06",
      "count": 4
    },
    {
      "period": "2025-07",
      "count": 25
    }
  ]
}

Ejemplos

curl -X GET "https://api.integrationit.co/api/usage-history?period=month&startDate=2025-01-01&endDate=2025-08-08" \
  -H "x-api-key: SU_API_KEY_AQUI"

Notas adicionales

  • El historial está disponible hasta 12 meses atrás.
  • Si se especifica group_by=day, los resultados se agruparán por día en lugar de por mes.
  • El campo period tiene el formato "YYYY-MM" para agrupación mensual o "YYYY-MM-DD" para agrupación diaria.
  • Para obtener información sobre el uso actual del mes en curso, utilice el endpoint /api/usage.