Get Statistics Overview
get_stats_overviewRetrieve email statistics for a chosen date range, grouped by day, week, or month, with optional subuser inclusion to identify performance trends and support data-driven decisions.
Instructions
Get a comprehensive overview of email statistics across multiple dimensions
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"start_date": "<start_date>"
},
"name": "get_stats_overview"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end_date | No | End date in YYYY-MM-DD format (defaults to today) | |
| start_date | Yes | Start date in YYYY-MM-DD format | |
| aggregated_by | No | How to group the statistics | day |
| include_subusers | No | Include subuser statistics in the overview |