Analytics

Get transactional email metrics

Changed on

Returns aggregate engagement metrics for one saved transactional email selected by ID or slug. Results are all-time unless a period or custom range is supplied.

get/metrics/transactional/{idOrSlug}

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/metrics/transactional/{idOrSlug}
  • Auth
    HTTP bearer

Path parameters

idOrSlugstring required

Saved transactional email ID or API slug.

Query parameters

period'1h' | '24h' | '7d' | '30d' | '90d'

Optional sliding time window. Ignored when start/end are provided.

startstring date-time

Custom range start. Must be used with end.

endstring date-time

Custom range end. Must be used with start; maximum 90 days.

includeMachineEngagementboolean

Include detected scanner, preview, and tracked asset open/click events.

Response

Transactional email metrics

successboolean
periodstring
startstring date-time
endstring date-time

Changes

  • 252c4dc556c7Revision changes
    • info

      added the optional property / to the response with the status

  • db3873ca3d4dRevision changes
    • 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

      added the optional property to the response with the status