Skip to content

Obtener logs mensuales globales del medidor de servicios​

GET
/service-meter/global/monthly-logs

Obtiene los agregados mensuales de uso de servicios a nivel global (todas las organizaciones) para análisis de plataforma y reportes ejecutivos.

Acceso restringido: Solo disponible para usuarios con permisos de administrador master.

Comportamiento de paginación:

  • Con includeCount=true: Devuelve los logs con el total de registros para paginación del servidor
  • Sin includeCount o includeCount=false: Devuelve solo los logs sin información de conteo

Authorizations​

bearerAuth

JWT token de autenticación. Utilice este esquema para autenticar solicitudes con un token JWT.

TypeHTTP (bearer)

Parameters​

Query Parameters

limit

Número máximo de registros a retornar

Typeinteger
Example12
minimum1
maximum24
default12
offset

Número de registros a omitir para paginación

Typeinteger
Example0
minimum0
default0
after

Fecha de inicio del rango (formato YYYY-MM-DD)

Typestring
Example2024-01-01
formatdate
before

Fecha de fin del rango (formato YYYY-MM-DD)

Typestring
Example2024-12-31
formatdate
feature

Filtrar por tipo de servicio específico

Typestring
Enum
smsemailcallapi-reqanalysisverification
Examplesms
includeCount

Si se incluye el total de registros para paginación del servidor.

  • true: Devuelve {data: {logs: [...], total: number}}
  • false o ausente: Devuelve {data: {logs: [...]}}
Typeboolean
Exampletrue
defaultfalse

Responses​

Logs mensuales globales obtenidos exitosamente
application/json
JSON
{
"status": "string",
"data": {
"logs": [
{
"month": "2024-01",
"totalUsage": 456780,
"totalCost": 85740500,
"currency": "COP",
"featureBreakdown": {
"sms": {
"count": 254800,
"cost": 38220000
},
"email": {
"count": 126400,
"cost": 12640000
},
"api-req": {
"count": 75580,
"cost": 37790000
}
},
"activeOrganizations": 425,
"growthRate": 15.2
}
],
"total": 24
}
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI