Mensajes de Uso
Devuelve series diarias y totales de mensajes. La respuesta distingue entre el volumen total, los mensajes que se cobran y los mensajes fallidos/no facturables.
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 ISO 8601 con offset. Si se omite, usa el inicio del periodo de facturación | — |
endDate | string | Fecha final ISO 8601 con offset. Si se omite, usa el fin del periodo de facturación | — |
groupBy | enum | type (default), channel, templateCategory, campaign o status | — |
mode | enum | fast (default) usa agregados diarios; full lee transacciones para costos detallados | — |
universe | enum | all (default) incluye fallidos/no facturables; billable muestra sólo los que se cobran | — |
Ejemplo: sólo mensajes que se cobran
curl "https://api.platica.mx/v1/usage/messages?workspace=g6yCA16pkWl5eXo7KszB&groupBy=status&universe=billable" \
-H "Authorization: Bearer $PLATICA_API_KEY"Respuesta
{
"workspaces": [
{
"id": "g6yCA16pkWl5eXo7KszB",
"name": "Mi empresa",
"billingPeriod": {
"startDate": "2026-06-01T06:00:00.000Z",
"endDate": "2026-07-01T05:59:59.999Z"
},
"dataSince": "2026-05-21T06:00:00.000Z",
"universe": "all",
"usage": {
"planName": "Growth",
"credits": 6500,
"mode": "fast",
"groupBy": "type",
"range": {
"startDate": "2026-06-01T06:00:00.000Z",
"endDate": "2026-07-01T05: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,
"nonBillableMessages": 0,
"creditsUsed": 950,
"includedValueCentavos": 0,
"overageCentavos": 0,
"changePct": -11.2
},
{
"group": "Campaña",
"messages": 250,
"nonBillableMessages": 12,
"creditsUsed": 358,
"includedValueCentavos": 0,
"overageCentavos": 0,
"changePct": 0
}
],
"summary": {
"totalMessages": 1200,
"billableMessages": 1188,
"nonBillableMessages": 12,
"failedMessages": 12,
"serviceCount": 950,
"campaignCount": 250,
"creditsUsed": 1308,
"credits": 6500,
"totalChangePct": -8.8,
"serviceChangePct": -11.2,
"campaignChangePct": 0
}
}
}
],
"workspacesCount": 1
}Campos principales
| Campo | Descripción |
|---|---|
universe | Universo solicitado: all o billable |
usage.mode | Modo efectivo. Enterprise siempre responde fast |
usage.groupBy | Dimensión aplicada |
usage.range | Rango efectivo evaluado |
usage.series | Serie diaria del universo seleccionado |
usage.totalsByGroup[].messages | Mensajes del grupo dentro del universo seleccionado |
usage.totalsByGroup[].nonBillableMessages | Mensajes del grupo que no se cobran |
usage.totalsByGroup[].changePct | Cambio contra el periodo anterior de igual duración. En full puede ser null |
usage.summary.totalMessages | Volumen total, incluidos fallidos/no facturables |
usage.summary.billableMessages | Mensajes que se cobran |
usage.summary.nonBillableMessages | Mensajes que no se cobran |
usage.summary.failedMessages | Mensajes fallidos; no consumen saldo |
usage.summary.creditsUsed | Créditos consumidos (omitido en enterprise) |
usage.freshness | Fuente, última actualización y desfase esperado |
Modos
| Modo | Uso recomendado |
|---|---|
fast | Dashboards y monitoreo. Incluye cambio porcentual por grupo y normalmente tiene segundos de desfase |
full | Conciliación exacta de costos sobre transacciones. Máximo 92 días; changePct por grupo puede ser null |
Nota
En enterprise, Platica siempre usa agregados (mode: "fast") aunque solicites mode=full. Se omiten creditsUsed y costos porque las tarifas se definen por contrato, pero se conservan nonBillableMessages y changePct por grupo.