Mensajes de Uso
Devuelve series diarias y totales de mensajes usados. Sirve para dashboards de consumo, alertas internas y conciliación de campañas.
GET https://api.platica.mx/v1/usage/messagesParámetros de consulta
| Parámetro | Tipo | Descripción | Requerido |
|---|---|---|---|
workspace | string | Filtra la respuesta a un workspace específico. Si se omite, devuelve todos los workspaces accesibles | — |
startDate | string | Fecha inicial en formato ISO 8601. Si se omite, usa el inicio del periodo de facturación | — |
endDate | string | Fecha final en formato ISO 8601. Si se omite, usa el fin del periodo de facturación | — |
groupBy | enum | Dimensión de agrupación: type (default), channel, templateCategory o campaign | — |
mode | enum | fast (default) lee agregados diarios; full escanea transacciones para calcular costos detallados | — |
Respuesta
{
"workspaces": [
{
"id": "g6yCA16pkWl5eXo7KszB",
"name": "Mi empresa",
"billingPeriod": {
"startDate": "2026-06-01T00:00:00.000Z",
"endDate": "2026-06-30T23:59:59.999Z"
},
"dataSince": "2026-05-21T06:00:00.000Z",
"usage": {
"planName": "Growth",
"credits": 6500,
"mode": "fast",
"groupBy": "type",
"range": {
"startDate": "2026-06-01T00:00:00.000Z",
"endDate": "2026-06-30T23:59:59.999Z"
},
"freshness": {
"source": "daily_aggregations",
"lastUpdated": "2026-06-29T18:31:10.000Z",
"expectedLagSeconds": 30
},
"series": [
{ "date": "2026-06-29T12:00:00.000Z", "group": "Servicio", "value": 180 },
{ "date": "2026-06-29T12:00:00.000Z", "group": "Campaña", "value": 40 }
],
"totalsByGroup": [
{ "group": "Servicio", "messages": 950, "creditsUsed": 950, "includedValueCentavos": 0, "overageCentavos": 0, "changePct": null },
{ "group": "Campaña", "messages": 250, "creditsUsed": 370, "includedValueCentavos": 0, "overageCentavos": 0, "changePct": null }
],
"summary": {
"totalMessages": 1200,
"serviceCount": 950,
"campaignCount": 250,
"creditsUsed": 1320,
"credits": 6500,
"totalChangePct": -8.8,
"serviceChangePct": -11.2,
"campaignChangePct": 0
}
}
}
],
"workspacesCount": 1
}Campos de la respuesta
| Campo | Descripción |
|---|---|
id | ID del workspace |
name | Nombre del workspace |
billingPeriod | Periodo de facturación activo del workspace |
usage.planName | Nombre del plan. En workspaces enterprise es enterprise |
usage.credits | Créditos incluidos del workspace |
usage.mode | Modo de cálculo usado: fast o full |
usage.groupBy | Dimensión de agrupación aplicada |
usage.range | Rango efectivo de fechas evaluado |
usage.series | Serie diaria con date, group y value |
usage.totalsByGroup | Totales por grupo con messages y, en planes no enterprise, campos de costo |
usage.summary.totalMessages | Total de mensajes usados |
usage.summary.serviceCount | Mensajes de servicio |
usage.summary.campaignCount | Mensajes de campaña o plantilla |
usage.summary.creditsUsed | Créditos consumidos estimados (no se incluye en workspaces enterprise) |
usage.freshness | Última actualización y desfase esperado |
Modos
| Modo | Uso recomendado |
|---|---|
fast | Monitoreo y dashboards. Normalmente refleja mensajes con desfase de segundos |
full | Conciliación de costos y overage. Lee transacciones y está limitado a rangos cortos |
Nota
En workspaces enterprise, la respuesta conserva credits pero omite creditsUsed y los campos de costo (includedValueCentavos, overageCentavos). Estos clientes tienen tarifas personalizadas; usa los conteos de mensajes por grupo para monitoreo.