Sign in
latestOpenAPI 3.0.32026-08-1410025.4 KB

1d5c69423568

Usage

Export team usage metrics

Export team usage metrics as JSON or CSV. Usage Metrics in Shortcut provides a prefilled request with your team_id; use these query parameters to customize the date range, output format, and optional platform grouping. API keys must belong to a user with usage metrics access for the requested team or organization.

get/api/v1/team/usage-export

Query parameters

team_idstring

Team or organization ID to export. Required for API-key integrations. Usage Metrics shows a prefilled request for the current organization.

period'day' | 'week' | 'month' | '60days' | '90days' | 'all'

Relative date range to export when start_date and end_date are omitted.

start_datestring

YYYY-MM-DD. Must be provided together with end_date; takes precedence over period.

end_datestring

YYYY-MM-DD. Must be provided together with start_date; takes precedence over period.

timezonestring

IANA timezone used to resolve relative periods and day boundaries.

format'json' | 'csv'

Response format.

report'summary' | 'daily'

CSV only. summary exports per-member totals; daily exports member usage by day.

group_by'platform'

JSON only. Add platform usage breakdowns to the response.

Response

Default Response