TRtraversal
usage

List Counts

Changed on

One page of the caller's own organization's per-member consumption, as of date.

date is the exclusive end of the window being reported on. Omitting it reports on now, which is what makes the reply cover the window in progress.

get/organization/usage/user-counts

Request

  • Base URL
    https://api.traversal.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.traversal.com/organization/usage/user-counts
  • Auth
    none declared

Query parameters

policy_idstring uuid nullable
resource_kind'investigation'

A category of product activity metered and governed on its own.

Two activities are different kinds when their accounting or entitlement behavior differs, not merely because a user would name them differently.

datestring date-time nullable

Exclusive end of the window to report on, which selects what was live at that instant. Absent means the window containing now.

querystring nullable

Matched against the member's name and email.

pageinteger
page_sizeinteger
sort_by'count'

Allowlisted sort fields; every value must name a UserUsageCount field.

sort_order'asc' | 'desc'

Response

Successful Response

next_pageinteger nullable required

None on the last page.

prev_pageinteger nullable required

None on the first page.

total_entriesinteger required

Rows matching the filters across every page.

Changes

  • 4a4435773444Revision changes
    • info

      added subschema #3 to the //// response property anyOf list for the response status

    • info

      added the required property //// to the response with the status

  • 47dcc19b4addRevision changes
    • info

      endpoint added