get_stats_overview
Analyze email performance metrics across multiple dimensions including opens, clicks, and deliveries for specified date ranges to monitor campaign effectiveness.
Instructions
Get a comprehensive overview of email statistics across multiple dimensions
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| aggregated_by | No | How to group the statistics | day |
| end_date | No | End date in YYYY-MM-DD format (defaults to today) | |
| include_subusers | No | Include subuser statistics in the overview | |
| start_date | Yes | Start date in YYYY-MM-DD format |
Input Schema (JSON Schema)
{
"properties": {
"aggregated_by": {
"default": "day",
"description": "How to group the statistics",
"enum": [
"day",
"week",
"month"
],
"type": "string"
},
"end_date": {
"description": "End date in YYYY-MM-DD format (defaults to today)",
"type": "string"
},
"include_subusers": {
"default": false,
"description": "Include subuser statistics in the overview",
"type": "boolean"
},
"start_date": {
"description": "Start date in YYYY-MM-DD format",
"type": "string"
}
},
"required": [
"start_date"
],
"type": "object"
}