Class: Anthropic::Models::Beta::Organization::Analytics::SummaryListParams

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

Overview

See Also:

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

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::Anthropic

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

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(starting_date:, ending_date: nil, filter: nil, limit: nil, page: nil, request_options: {}) ⇒ void

Some parameter documentations has been truncated, see Anthropic::Models::Beta::Organization::Analytics::SummaryListParams for more details.

Parameters:

  • starting_date (Date) —

    UTC date in YYYY-MM-DD format. Start of the date range (inclusive). Data is typi

  • ending_date (Date, nil) (defaults to: nil) —

    UTC date in YYYY-MM-DD format. End of the date range (exclusive). Data is typica

  • filter (Array<String>, nil) (defaults to: nil) —

    Filters as dimension:value. Only rbac_group_id is supported (e.g. `filter=

  • limit (Integer, nil) (defaults to: nil) —

    Number of results per page (1-1000, default 100). The day series (at most 366 en

  • page (String, nil) (defaults to: nil) —

    Opaque cursor from a previous response's next_page field. next_page is curre

  • request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/anthropic/models/beta/organization/analytics/summary_list_params.rb', line 60

Instance Attribute Details

#ending_date ⇒ Date?

UTC date in YYYY-MM-DD format. End of the date range (exclusive). Data is typically available with a 1-day lag, so this can be at most today — which is also the default when omitted, making the last entry cover the most recent available day. Data may be revised by a few percent over the following days. The range may span at most 366 days.

Parameters:

  • value (Date, nil)

Returns:

  • (Date, nil) 


30
 
# File 'lib/anthropic/models/beta/organization/analytics/summary_list_params.rb', line 30

optional :ending_date, Date, nil?: true

#filter ⇒ Array<String>?

Filters as dimension:value. Only rbac_group_id is supported (e.g. filter[]=rbac_group_id:{id}); repeat the param to OR across groups. Scopes the whole day series to members of the matching group(s), re-aggregated from member-level activity — org-wide seat/invite fields and the adoption rates derived from them are null on scoped rows. rbac_group_id accepts 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 UTC day (time-of-usage attribution). At most 100 entries.

Parameters:

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

Returns:

  • (Array<String>, nil) 


43
 
# File 'lib/anthropic/models/beta/organization/analytics/summary_list_params.rb', line 43

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

#limit ⇒ Integer?

Number of results per page (1-1000, default 100). The day series (at most 366 entries) is currently returned in full in a single page, so limit does not yet shorten it.

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


51
 
# File 'lib/anthropic/models/beta/organization/analytics/summary_list_params.rb', line 51

optional :limit, Integer, nil?: true

#page ⇒ String?

Opaque cursor from a previous response's next_page field. next_page is currently always null, so there is never a cursor to send.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


58
 
# File 'lib/anthropic/models/beta/organization/analytics/summary_list_params.rb', line 58

optional :page, String, nil?: true

#starting_date ⇒ Date

UTC date in YYYY-MM-DD format. Start of the date range (inclusive). 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)

Returns:

  • (Date) 


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

required :starting_date, Date

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


39
 
# File 'sig/anthropic/models/beta/organization/analytics/summary_list_params.rbs', line 39

def to_hash: -> {