TRtraversal
usage

List Policies

Changed on

The caller's own organization's policies, as of date.

date is exclusive against creation and inclusive against retirement. Omitting it reports on now.

get/organization/usage/policies

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/policies
  • Auth
    none declared

Query parameters

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.

scope'user' | 'organization' | 'automation' | 'worker'

Whose consumption a policy counts.

AUTOMATION counts the whole organization exactly as ORGANIZATION does and differs only in which activity it accepts: human and automated work draw on separate budgets, so each of those two scopes counts one of them and refuses the other.

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.

Response

Successful Response

Changes

  • 4fa2a4911e01Revision changes
    • warning

      added the new worker enum value to the // response property for the response status

    • info

      added the enum value worker to the property anyOf[subschema #1: UsagePolicyScope]/ of the query request parameter scope

  • c5e1ea955e81Revision changes
    • warning

      added the new automation enum value to the // response property for the response status

    • info

      added the enum value automation to the property anyOf[subschema #1: UsagePolicyScope]/ of the query request parameter scope