Estadísticas
| Tool | Endpoint REST | Anotaciones |
|---|
get_usage_period | GET /v1/usage/period | lectura, idempotente |
get_usage_summary | GET /v1/usage/summary | lectura, idempotente |
get_usage_messages | GET /v1/usage/messages | lectura, idempotente |
get_usage_conversations | GET /v1/usage/conversations | lectura, idempotente |
get_usage_actors | GET /v1/usage/actors | lectura, idempotente |
get_usage_period
Devuelve el periodo de facturación activo del workspace: tipo de facturación, plan y créditos incluidos.
| Campo | Tipo | Requerido | Descripción |
|---|
workspace | string | no | ID del workspace. Si se omite, devuelve todos los workspaces accesibles por la API key. |
get_usage_summary
Devuelve el resumen principal de monitoreo: mensajes usados, créditos incluidos, conversaciones y tasa de autonomía.
| Campo | Tipo | Requerido | Descripción |
|---|
workspace | string | no | ID del workspace. Si se omite, devuelve todos los workspaces accesibles. |
startDate | string | no | Fecha inicial ISO 8601 con offset. Si se omite, usa el inicio del periodo de facturación. |
endDate | string | no | Fecha final ISO 8601 con offset. Si se omite, usa el fin del periodo de facturación. |
get_usage_messages
Devuelve series diarias y totales de mensajes usados. Puede agrupar por tipo, canal, categoría de plantilla o campaña.
| Campo | Tipo | Requerido | Descripción |
|---|
workspace | string | no | ID del workspace. Si se omite, devuelve todos los workspaces accesibles. |
startDate | string | no | Fecha inicial ISO 8601 con offset. |
endDate | string | no | Fecha final ISO 8601 con offset. |
groupBy | enum | no | type (default), channel, templateCategory o campaign. |
mode | enum | no | fast (default, agregados diarios) o full (transacciones, rangos cortos). |
get_usage_conversations
Devuelve métricas de conversaciones y autonomía, con desglose por plataforma, agente, canal o etiqueta.
| Campo | Tipo | Requerido | Descripción |
|---|
workspace | string | no | ID del workspace. Si se omite, devuelve todos los workspaces accesibles. |
startDate | string | no | Fecha inicial ISO 8601 con offset. |
endDate | string | no | Fecha final ISO 8601 con offset. |
breakdown | enum | no | platform (default), agent, channel o tag. |
get_usage_actors
Devuelve consumo de mensajes por actor: agente automático, usuarios del workspace, contactos y otros buckets capturados por Platica.
| Campo | Tipo | Requerido | Descripción |
|---|
workspace | string | no | ID del workspace. Si se omite, devuelve todos los workspaces accesibles. |
startDate | string | no | Fecha inicial ISO 8601 con offset. |
endDate | string | no | Fecha final ISO 8601 con offset. |