Sign in
Analytics

Get campaign metrics

Returns aggregated engagement metrics, attached campaign-goal results, a lifetime per-link click breakdown, and lifetime Poll/NPS summaries for a specific campaign. Clicked links and poll summaries are not limited by period/start/end.

get/metrics/campaigns/{campaignId}

Path parameters

campaignIdstring required

Campaign ID

Query parameters

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

Sliding time window. Ignored when start and end are provided.

startstring date-time

Start of custom time range (ISO 8601). Must be used with end.

endstring date-time

End of custom time range (ISO 8601). Must be used with start. Max range: 90 days.

mailboxProviderstring

Recipient mailbox provider filter (e.g. gmail, microsoft, yahoo, icloud). Scopes engagement metrics to recipients of that provider. Provider-filtered responses report replies, conversions, and revenue as 0 because those metrics cannot be segmented per provider.

includeMachineEngagementboolean

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

Response

Success

successboolean
campaignIdstring
periodstring

Echoed back when period is provided.

mailboxProviderstring

Echoed back when mailboxProvider is provided.

Changes

Changed in 15 of the 121 revisions of this API.222

  • 11b6d27ba1de1See the full diff
    • ○

      added the optional property goals to the response with the 200 status

      response-optional-property-added

  • ba3a29c6eb333See the full diff
    • ○

      added the optional property retryable to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property retryable to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property retryable to the response with the 503 status

      response-optional-property-added

  • 8fbabe82a04d1See the full diff
    • ○

      added the non-success response with the status 503

      response-non-success-status-added

  • 6fd2903b91ce2See the full diff
    • ○

      added the optional property code to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property code to the response with the 404 status

      response-optional-property-added

  • af1cf96204821See the full diff
    • ○

      added the optional property polls/items/allowMultiple to the response with the 200 status

      response-optional-property-added

  • aa6181241c7f2See the full diff
    • ○

      added the new optional query request parameter mailboxProvider

      new-optional-request-parameter

    • ○

      added the optional property mailboxProvider to the response with the 200 status

      response-optional-property-added

  • 36f92fc0caa22See the full diff
    • ▲

      the response property success became optional for the status 401

      response-property-became-optional

    • ▲

      the response property success became optional for the status 404

      response-property-became-optional

  • b58891ac1cde2See the full diff
    • ○

      added the optional property stats/rateDenominator to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property stats/rateDenominatorBasis to the response with the 200 status

      response-optional-property-added

  • afa92b16b62c1See the full diff
    • ○

      added the optional property recommendations to the response with the 200 status

      response-optional-property-added

  • ad2202945c5b2See the full diff
    • ○

      added the optional property stats/replies to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property stats/replyRate to the response with the 200 status

      response-optional-property-added