ARararahq
Templates

Consultar métricas do template

Changed on

Enviadas, entregues, lidas e falhas do template no período. sent soma enviadas, entregues e lidas. As taxas vêm como string com 1 casa decimal, calculadas sobre sent + failed. Permissão: READ.

get/v1/templates/{id}/analytics

Request

Path parameters

idstring uuid required

ID do template (UUID). O nome não é aceito aqui.

Query parameters

period'7d' | '30d' | '90d'

Valor fora da lista é tratado como 30d.

Response

Métricas

templateIdstring required
templateNamestring required
periodstring required
sentinteger required

Soma de enviadas, entregues e lidas.

deliveredinteger required
readinteger required
failedinteger required
deliveryRatestring required

Percentual com 1 casa decimal, como string (ex. "97.6"), calculado sobre sent + failed.

readRatestring required

Percentual com 1 casa decimal, como string.

Example response

{
  "templateId": "a7f3c1e2-4b5d-6789-abcd-ef0123456789",
  "templateName": "pedido_confirmado",
  "period": "30d",
  "sent": 1250,
  "delivered": 1230,
  "read": 890,
  "failed": 10,
  "deliveryRate": "97.6",
  "readRate": "70.6"
}

Changes

  • d576cd28afc0Revision changes
    • info

      api tag Templates added

    • info

      api tag templates removed

    • info

      added the non-success response with the status

  • 372d8c2e735dRevision changes
    • breaking

      the response's body type changed from object to no type for status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response's property type changed from object to string for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added to the response body anyOf list for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      removed the 30d enum value from the response property for the response status

    • info

      removed the 7d enum value from the response property for the response status

    • info

      removed the 90d enum value from the response property for the response status