Campaign Metrics
Query Metrics Related to Campaigns
Last updated
Was this helpful?
Query Metrics Related to Campaigns
Last updated
Was this helpful?
Fetch Campaign Metrics
The ID of the workspace
The date and time in the format 'YYYY-MM-DDTHH:MM:SSZ' or 'YYYY-MM-DDTHH:MM:SS-HH:MM'.
The date and time in the format 'YYYY-MM-DDTHH:MM:SSZ' or 'YYYY-MM-DDTHH:MM:SS-HH:MM'.
Filter conditions for fetching metrics. Each condition must be in the format: equals(field
,value
).
Supported field-value pairs:
campaignID
- UUID. Can supply multiple equals conditions to match multiple campaign IDs.name
- string. Can supply multiple equals conditions to match multiple campaign names.status
- string. Can supply multiple equals conditions to filter by campaign statuses.
Allowed values:
tagID
- UUID. Filter by campaigns with a specific tag.channelID
- UUID. Filter by campaigns sent via a specific channel.platformID
- string. Can supply multiple equals conditions to match multiple platforms.
Common values include: sms-messagebird, email-sparkpost, whatsapp.createdSince
- ISO-8601 timestamp string. Filter for campaigns created after this time.createdUpTo
- ISO-8601 timestamp string. Filter for campaigns created up to this time.