SHshortcut
Usage

Export team usage metrics

Changed on

Export stored team usage metrics as JSON or CSV. Historical data remains available when verification is missing or stale. reportingCoverage lists each UTC day as verified, unverified, stale, or live; totals are verified, partial, or provisional. Partial totals include all stored values but may be incomplete or outdated; missing unverified days do not establish zero usage. Today is live and provisional. CSV includes equivalent verification columns. The "pure cost" field is usage credits multiplied by the current active contract's credit_overage_rate in USD; it is a usage valuation at that rate, not an invoice total or provider cost. All viewers with usage metrics access receive dollar values when a valid contract rate is available. When there is no active contract or its rate is missing or non-positive, exports return credit metrics and omit dollar values. 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

Request

  • Base URL
    https://api.shortcut.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Query parameters

detail'executions'

With report=work, include retained execution details in JSON or export one CSV row per execution group. Includes current conversation titles and associated file IDs only with prompt-history permission and verified scope. Current workbook filenames are separately resolved under scoped metadata authority; workbook content and download access are not granted.

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 when explicit dates are omitted. all starts at the later of usage tracking or team creation, while preserving any older stored usage.

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' | 'work'

summary exports per-member totals; daily exports member usage by day. work returns deterministic gross metered credits grouped by explicit work reference and workflow category, in JSON or CSV.

platform'web' | 'excel' | 'sheets' | 'desktop' | 'shortcutxl' | 'api' | 'unknown'

Work report platform filter.

work_reference_idstring

Work report reference UUID, or unassigned.

workflow_categorystring

Exact work report category filter.

revisionstring

Expected work report revision. A changed source or attribution returns 409.

group_by'platform'

JSON only. Add platform usage breakdowns to the response.

Response

Default Response

Changes

  • 4ae382e2c957Revision changes
    • info

      added the new optional query request parameter detail

    • info

      added the new optional query request parameter platform

    • info

      added the new optional query request parameter revision

    • info

      added the new optional query request parameter work_reference_id

    • info

      added the new optional query request parameter workflow_category

    • info

      added the new enum value work to the query request parameter report