Skip to main content
POST
Get Team Metrics

Authorizations

X-API-Key
string
header
required

Body

application/json
fromUtc
string<date-time> | null

UTC lower bound. The metrics service treats this as the start of the UTC day.

toUtc
string<date-time> | null

UTC upper bound. The metrics service treats this as the end of the UTC day.

flowPlanIds
(string | null)[] | null

Flow plan ids to filter by. These map to MetricsFiltersDto.source_ids and are expanded to enrollments by the metrics service.

userIds
(string | null)[] | null

Team member user ids to filter by. Team owners can omit for all team users; non-owners are scoped by the service to their own user.

includeTotals
boolean
default:true

Include total actions, engagements, and opportunities. Defaults to true.

includeActions
boolean
default:true

Include automated outreach, manual task, and Flow Agent action counts. Defaults to true.

includeEngagement
boolean
default:true

Include email/LinkedIn engagement counts and reply sentiment. Defaults to true.

includeOpportunities
boolean
default:true

Include opportunity totals such as positive replies and meetings booked. Defaults to true.

includeEmailChart
boolean
default:false

Include email trend/chart buckets. Defaults to false; enable only when the customer asks for chart, trend, or by-day/by-month data. If chart data is requested without a full date range, missing bounds default to a recent 30-day window.

includeLinkedinChart
boolean
default:false

Include LinkedIn trend/chart buckets. Defaults to false; enable only when the customer asks for chart, trend, or by-day/by-month data. If chart data is requested without a full date range, missing bounds default to a recent 30-day window.

Response

Tool result.

summary
string
required
effectiveFilters
object
required
totals
object | null
required
actions
object | null
required
engagement
object | null
required
opportunities
object | null
required
emailChart
object[] | null
required
linkedinChart
any[] | null
required
warnings
string[]
required
nextSteps
string[]
required