Analytics

Get campaign metrics

Backward-compatible alias for GET /metrics/campaigns/{campaignId}. Returns aggregated engagement metrics for a specific campaign.

get/campaigns/{campaignId}/stats

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.

includeMachineEngagementboolean

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

Response

Success

successboolean
campaignIdstring
periodstring

Changes