Sign in
Beta
Usage Metrics

List Usage Metrics

List usage metrics with filtering and pagination.

get/api/v1/beta/usage-metrics

Query parameters

page_sizeinteger nullable

Number of items per page

Number of items per page

page_tokenstring nullable

Token for pagination

Token for pagination

include_totalboolean

Include total count in response

Include total count in response

project_idstring uuid nullable

Filter by project ID

Filter by project ID

user_idstring nullable

Filter by user ID

Filter by user ID

event_typesstring[] nullable

Filter by event types

Filter by event types

daysstring[] nullable

Filter by specific days (YYYY-MM-DD)

Filter by specific days (YYYY-MM-DD)

day_on_or_beforestring nullable

Filter by days on or before this date (YYYY-MM-DD)

Filter by days on or before this date (YYYY-MM-DD)

day_on_or_afterstring nullable

Filter by days on or after this date (YYYY-MM-DD)

Filter by days on or after this date (YYYY-MM-DD)

event_aggregation_typestring nullable

Filter by event aggregation type

Filter by event aggregation type

event_aggregation_keystring nullable

Filter by event aggregation key

Filter by event aggregation key

organization_idstring uuid required

Cookies

sessionstring nullable

Response

Successful Response

next_page_tokenstring nullable

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

total_sizeinteger nullable

The total number of items available. This is only populated when specifically requested. The value may be an estimate and can be used for display purposes only.

Changes

Changed in 1 of the 33 revisions of this API.22

  • b17341164de922See the full diff
    • ●

      added the new directory_count_snapshot enum value to the items/items/event_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new directory_file_count_snapshot enum value to the items/items/event_type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property detail/items/ctx to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property detail/items/input to the response with the 422 status

      response-optional-property-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog