templates

Analytics agregadas de um template

Conta mensagens enviadas, entregues, lidas e falhadas via GROUP BY no banco.

get/v1/templates/{id}/analytics

Path parameters

idstring uuid required

Query parameters

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

Response

Analytics

templateIdstring required
templateNamestring required
period'7d' | '30d' | '90d' required
sentinteger required
deliveredinteger required
readinteger required
failedinteger required
deliveryRatestring required

Percentual formatado com 1 casa decimal (ex. "98.7").

readRatestring required

Changes

Changed in 1 of the 4 revisions of this API.15

    • api tag templates added

      api-tag-added

    • api tag Templates removed

      api-tag-removed

    • added the new optional query request parameter period

      new-optional-request-parameter

    • added the media type application/json for the response with the status 403

      response-media-type-added

    • added the media type application/json for the response with the status 404

      response-media-type-added

    • added the non-success response with the status 401

      response-non-success-status-added

    • the response property delivered became required for the status 200

      response-property-became-required

    • the response property deliveryRate became required for the status 200

      response-property-became-required

    • the response property failed became required for the status 200

      response-property-became-required

    • the response property read became required for the status 200

      response-property-became-required

    • the response property readRate became required for the status 200

      response-property-became-required

    • the response property sent became required for the status 200

      response-property-became-required

    • added the required property period to the response with the 200 status

      response-required-property-added

    • added the required property templateId to the response with the 200 status

      response-required-property-added

    • added the required property templateName to the response with the 200 status

      response-required-property-added

    This revision also has 24 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog