Class: Anthropic::Models::Beta::Organization::Analytics::UserListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/anthropic/models/beta/organization/analytics/user_list_params.rb,
sig/anthropic/models/beta/organization/analytics/user_list_params.rbs

Overview

See Also:

  • Anthropic::Resources::Beta::Organization::Analytics::Users#list

Defined Under Namespace

Modules: GroupBy, Order

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::Anthropic

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize ⇒ void 



42
 
# File 'sig/anthropic/models/beta/organization/analytics/user_list_params.rbs', line 42

def initialize: (

Instance Attribute Details

#date ⇒ Date?

UTC date in YYYY-MM-DD format. The day to get user activity for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.

Parameters:

  • value (Date, nil)

Returns:

  • (Date, nil) 


20
 
# File 'lib/anthropic/models/beta/organization/analytics/user_list_params.rb', line 20

optional :date, Date, nil?: true

#ending_date ⇒ Date?

UTC date in YYYY-MM-DD format. End of the date range (exclusive); only valid with starting_date. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day), so this can be at most today — which is also the default when omitted, resolved once when the first page is served and reused for the rest of the pagination sequence. At most 366 days after starting_date.

Parameters:

  • value (Date, nil)

Returns:

  • (Date, nil) 


31
 
# File 'lib/anthropic/models/beta/organization/analytics/user_list_params.rb', line 31

optional :ending_date, Date, nil?: true

#filter ⇒ Array<String>?

Filters as dimension:value, e.g. filter[]=rbac_group_id:{id}. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: project_id, rbac_group_id, user_id. Value forms: project_id takes a tagged project id (claude_proj_...) and scopes each member's row to their claude.ai chat activity within that project (it cannot be combined with group_by[] or an rbac_group_id filter); rbac_group_id takes the tagged id (rbac_group_..., as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); user_id takes a tagged user id (user_...), as emitted in responses. An unsupported dimension returns 400. At most 100 entries.

Parameters:

  • value (::Array[String], nil)

Returns:

  • (Array<String>, nil) 


47
 
# File 'lib/anthropic/models/beta/organization/analytics/user_list_params.rb', line 47

optional :filter, Anthropic::Internal::Type::ArrayOf[String], nil?: true

#group_by ⇒ Array<Symbol, Anthropic::Models::Beta::Organization::Analytics::UserListParams::GroupBy>?

Dimensions to break results out by (e.g. group_by[]=rbac_group_id). Supported on this endpoint: rbac_group_id. Rows are already per-member, so the one supported grouping aggregates them per RBAC group instead. Grouped rows carry the requested dimension values as additional fields and paginate like ungrouped responses via next_page; an unsupported dimension returns 400. rbac_group_id attributes a user to every group they held at any point during each covered UTC day, so grouped rows are not an exclusive partition and can sum above org-level totals. At most 100 entries.

Parameters:

  • value (::Array[Anthropic::Models::Beta::Organization::Analytics::UserListParams::group_by], nil)

Returns:



60
61
62
63
64
 
# File 'lib/anthropic/models/beta/organization/analytics/user_list_params.rb', line 60

optional :group_by,
-> {
  Anthropic::Internal::Type::ArrayOf[enum: Anthropic::Beta::Organization::Analytics::UserListParams::GroupBy]
},
nil?: true

#limit ⇒ Integer?

Number of results per page (1-1000, default 100).

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


70
 
# File 'lib/anthropic/models/beta/organization/analytics/user_list_params.rb', line 70

optional :limit, Integer, nil?: true

#order ⇒ Symbol, ...

Sort direction: asc or desc. Defaults to asc for the endpoint's sort column and to desc when order_by names a metric (a top-N ranking). Applies to order_by, or to the endpoint's default sort field when order_by is omitted.

Parameters:

  • value (Anthropic::Models::Beta::Organization::Analytics::UserListParams::order, nil)

Returns:



79
80
81
82
83
 
# File 'lib/anthropic/models/beta/organization/analytics/user_list_params.rb', line 79

optional :order,
enum: -> {
  Anthropic::Beta::Organization::Analytics::UserListParams::Order
},
nil?: true

#order_by ⇒ String?

Sort field. Restricted to the endpoint's sort column plus its rankable metrics (metrics default to descending; a few metrics rank in date-range mode only, per the endpoint's documented orderable set).

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


91
 
# File 'lib/anthropic/models/beta/organization/analytics/user_list_params.rb', line 91

optional :order_by, String, nil?: true

#page ⇒ String?

Opaque cursor from a previous response's next_page field.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


97
 
# File 'lib/anthropic/models/beta/organization/analytics/user_list_params.rb', line 97

optional :page, String, nil?: true

#starting_date ⇒ Date?

UTC date in YYYY-MM-DD format. Start of a date range (inclusive). Enables rollup mode: one row per entity aggregated over the whole range — addable counters are summed across days, and a distinct count is never summed where summing could double-count (a field's range value is recomputed exactly over the window, approximate via HLL with typical error under 2%, null, or — for the creation-event counts, whose per-day values cannot overlap — a per-day sum that is itself exact; each field's own description says which). Use either date or starting_date, not both. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.

Parameters:

  • value (Date, nil)

Returns:

  • (Date, nil) 


113
 
# File 'lib/anthropic/models/beta/organization/analytics/user_list_params.rb', line 113

optional :starting_date, Date, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/anthropic/models/beta/organization/analytics/user_list_params.rb', line 145

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


55
 
# File 'sig/anthropic/models/beta/organization/analytics/user_list_params.rbs', line 55

def to_hash: -> {