Class: Anthropic::Models::Beta::Organization::Analytics::ArtifactListParams

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

Overview

See Also:

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

Defined Under Namespace

Modules: GroupBy

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 ⇒ void 



30
 
# File 'sig/anthropic/models/beta/organization/analytics/artifact_list_params.rbs', line 30

def initialize: (

Instance Attribute Details

#date ⇒ Date

UTC date in YYYY-MM-DD format. The day to get artifact 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.



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

required :date, Date

#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: artifact_type, is_shared, product, rbac_group_id, user_id. Value forms: artifact_type is a canonical artifact MIME type (e.g. text/markdown) or other; is_shared is true or false; product is chat, claude_code, or cowork (the surfaces that create artifacts); 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.



36
 
# File 'lib/anthropic/models/beta/organization/analytics/artifact_list_params.rb', line 36

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

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

Dimensions to break results out by: product, user_id and/or rbac_group_id. The ungrouped artifact-type cube is finite and returned in full; grouped queries multiply the cube and paginate via next_page. product takes the values chat, claude_code, or cowork (the surfaces that create artifacts). rbac_group_id attributes a user to every group they held at any point during the requested UTC day, so grouped rows are not an exclusive partition. At most 100 entries.



48
49
50
51
52
 
# File 'lib/anthropic/models/beta/organization/analytics/artifact_list_params.rb', line 48

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

#limit ⇒ Integer?

Maximum rows to return (1-1000, default 100). The ungrouped artifact-type cube is finite and returned in full; limit is the page size only when group_by[] multiplies the cube.



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

optional :limit, Integer, nil?: true

#page ⇒ String?

Opaque cursor from a previous response's next_page field. Only valid with group_by[] — the ungrouped cube is never paginated.



67
 
# File 'lib/anthropic/models/beta/organization/analytics/artifact_list_params.rb', line 67

optional :page, String, nil?: true

Instance Method Details

#to_hash ⇒ { 



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

def to_hash: -> {