Appearance

List Utilization ​

Endpoint ​

http
GET /unified/user-directory/utilization
Integrations supported
  • Adobe
  • DocuSign
  • GitHub
  • Jira
  • Salesforce
  • Zendesk
  • Zoom

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
created_at
string · date-time

The date and time the utilization was created, can only be used with utilization type user_activity.

Supported in
  • Zoom
utilization_type
string

The type of the utilization report

All possible enum values:
  • actions
  • licenses
  • packages
  • shared-storage
  • user_activity
Enum support by integration
  • Zoom
    • user_activity
    • licenses
  • Adobe
    • licenses
  • Zendesk
    • licenses
  • Jira
    • licenses
  • Salesforce
    • licenses
  • GitHub
    • actions
    • packages
    • shared-storage
Required in
  • Adobe
  • GitHub
  • Jira
  • Salesforce
  • Zendesk
  • Zoom
user_id
string

The unique user identifier

Required in
  • DocuSign
organization_id
string

The unique identifier for the organization

Required in
  • GitHub

Response Body ​

result
object[]

List of Utilization

name
string
REQUIRED · 

Name of the utilization report

Supported in
  • Adobe
  • DocuSign
  • GitHub
  • Jira
  • Salesforce
  • Zendesk
  • Zoom
metadata
object

Metadata of the utilization report

columns
object[]
REQUIRED · 

Columns of the utilization report

Supported in
  • Adobe
  • DocuSign
  • GitHub
  • Jira
  • Salesforce
  • Zendesk
  • Zoom
label
string

Label of the column data

description
string

Description of the column data

format
string

Format of the column data

rows
array[]

Rows of the utilization report

Supported in
  • Adobe
  • DocuSign
  • GitHub
  • Jira
  • Salesforce
  • Zendesk
  • Zoom
remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.