get_campaign_summary
Retrieve campaign analytics summary including validations, redemptions, and publications. Optionally filter by date range for performance analysis.
Instructions
Retrieve comprehensive analytics summary for a specific campaign.
Returns detailed statistics including validations, redemptions, publications, and campaign-type-specific metrics for performance analysis.
Parameters:
campaign_id: Valid campaign identifier with 'camp_' prefix
start_date: Optional analysis period start (ISO 8601 date format)
end_date: Optional analysis period end (ISO 8601 date format)
Date Parameter Rules:
Both start_date and end_date must be provided together or omitted together
Empty strings are invalid - use null/None for no date filtering
Omitting both dates returns full campaign period summary
Date format: YYYY-MM-DD (e.g., "2025-01-01")
Examples:
get_campaign_summary(campaign_id="camp_aPVb581gdJ1xF6esnDnDocVK")
get_campaign_summary( campaign_id="camp_aPVb581gdJ1xF6esnDnDocVK", start_date="2025-01-01", end_date="2025-01-31" )
Examples of bad usage:
get_campaign_summary(campaign_id="camp_aPVb581gdJ1xF6esnDnDocVK", start_date="", end_date="")
Returns: JSON object containing campaign analytics including:
validations: Validation attempt statistics
redemptions: Successful redemption counts and values
publications: Voucher distribution metrics
campaign_type specific metrics (varies by campaign type)
date range information
performance indicators
Raises:
ToolError: If campaign not found, invalid date format, or mismatched date parameters
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end_date | No | ||
| start_date | No | ||
| campaign_id | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |