Get Engagement Summary
Returns a count and total annual value of engagements grouped by status for the tenant.
Optionally filter by date range:
- Use dateRange for preset ranges (ThisWeek, ThisMonth, ThisYear, etc.)
- Use dateFrom/dateTo for custom ranges (when dateRange is CustomDateRange)
- When using a preset range, dateFrom and dateTo must not be provided
Parameters
| Name | Type | Description |
|---|---|---|
| tenant* | path string | The Tenant.Code |
The Tenant.Code |
||
| dateFrom | query string (date) | |
| dateRange | query enum | ThisWeek NextWeek Last7Days Next7Days Last30Days Next30Days PreviousMonth ThisMonth NextMonth PreviousQuarter ThisQuarter NextQuarter PreviousYear ThisYear NextYear YearToDate PreviousFinancialYear ThisFinancialYear NextFinancialYear FinancialYearToDate Today CustomDateRange |
ThisWeek NextWeek Last7Days Next7Days Last30Days Next30Days PreviousMonth ThisMonth NextMonth PreviousQuarter ThisQuarter NextQuarter PreviousYear ThisYear NextYear YearToDate PreviousFinancialYear ThisFinancialYear NextFinancialYear FinancialYearToDate Today CustomDateRange |
||
| dateTo | query string (date) | |
Responses
200 OK
401 Unauthorized – Invalid or missing API key