Team Performance

Get team orders distribution

Changed on

Order counts grouped by time breakdown (hour, day of week, day, week, month)

get/teams/{teamId}/performance/orders

Request

  • Base URL: https://api.session.services
  • URL: https://api.session.services/teams/{teamId}/performance/orders
  • Auth: API key in header x-tenant-id

Path parameters

teamIdstring required

Team identifier

Query parameters

groupBy'HOUR' | 'DAY_OF_WEEK' | 'DAY' | 'WEEK' | 'MONTH'

Time breakdown for aggregation

timeZonestring

IANA time zone for interpreting date ranges

startDatestring date required

Start date (YYYY-MM-DD)

endDatestring date required

End date (YYYY-MM-DD)

Response

OK

groupBy'HOUR' | 'DAY_OF_WEEK' | 'DAY' | 'WEEK' | 'MONTH' required

The grouping used for aggregation

totalOrdersnumber required

Total orders across all buckets

Changes