WOwove
Analytics

Get usage report

Your organization's usage report: active users, documents processed, quote assignments, edits and shipments / customs entries pushed to your TMS, per day or week, plus a per-user breakdown. The same report as the dashboard's usage card and CSV export. Requires analytics:read.

The window is startDate/endDate if given, else the last days UTC days (today included), else the last weeks Monday-aligned UTC weeks. Windows of 14 days or less are bucketed by day, longer ones by week, with the first and last week clipped to the window. At most 366 days.

get/api/v1/external/analytics/usage

Request

Query parameters

startDatestring date-time

Start of the window, ISO 8601 (UTC). Takes precedence over days and weeks.

endDatestring date-time

End of the window, inclusive, ISO 8601 (UTC). Defaults to now.

daysinteger

The last N UTC days, today included. Takes precedence over weeks.

weeksinteger

The last N Monday-aligned UTC weeks, the current one included

Response

Usage report retrieved successfully

successboolean

Example response

{
  "success": true,
  "data": {
    "buckets": [
      {
        "bucketStart": "2026-10-01",
        "bucketEnd": "2026-10-04",
        "label": "Oct 1"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.