Class: Imagekitio::Models::Accounts::UsageAnalyticsResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/imagekitio/models/accounts/usage_analytics_response.rb,
sig/imagekitio/models/accounts/usage_analytics_response.rbs

Overview

See Also:

  • Imagekitio::Resources::Accounts::UsageAnalytics#get

Defined Under Namespace

Classes: Browser, Cache, Country, Device, ErrorReason, Extension, Format, StatusCode, Top404Asset, TopImageTransforms, TopImages, TopOtherAssets, TopReferrers, TopUserAgents, TopVideoTransforms, TopVideos, URLEndpoints, VideoProcessing

Instance Attribute Summary collapse

Instance Method Summary collapse

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(name:) ⇒ Object

Some parameter documentations has been truncated, see Imagekitio::Models::Accounts::UsageAnalyticsResponse::URLEndpoints::ByRequest for more details.

Parameters:

  • name (String) —

    URL endpoint name, or Default for traffic that does not match a named endpoint




# File 'lib/imagekitio/models/accounts/usage_analytics_response.rb', line 192

Instance Attribute Details

#bandwidth_bytes ⇒ Float

Total bandwidth, in bytes, utilized during the specified date range.

Parameters:

  • value (Float)

Returns:

  • (Float) 


12
 
# File 'lib/imagekitio/models/accounts/usage_analytics_response.rb', line 12

required :bandwidth_bytes, Float, api_name: :bandwidthBytes

#browser ⇒ Imagekitio::Models::Accounts::UsageAnalyticsResponse::Browser

CDN traffic grouped by browser.

Parameters:

  • value (Imagekitio::Accounts::UsageAnalyticsResponse::Browser)

Returns:



18
 
# File 'lib/imagekitio/models/accounts/usage_analytics_response.rb', line 18

required :browser, -> { Imagekitio::Accounts::UsageAnalyticsResponse::Browser }

#cache ⇒ Imagekitio::Models::Accounts::UsageAnalyticsResponse::Cache

CDN cache hit, miss and error counts for the date range.

Parameters:

  • value (Imagekitio::Accounts::UsageAnalyticsResponse::Cache)

Returns:



24
 
# File 'lib/imagekitio/models/accounts/usage_analytics_response.rb', line 24

required :cache, -> { Imagekitio::Accounts::UsageAnalyticsResponse::Cache }

#country ⇒ Imagekitio::Models::Accounts::UsageAnalyticsResponse::Country

CDN traffic grouped by country.

Parameters:

  • value (Imagekitio::Accounts::UsageAnalyticsResponse::Country)

Returns:



30
 
# File 'lib/imagekitio/models/accounts/usage_analytics_response.rb', line 30

required :country, -> { Imagekitio::Accounts::UsageAnalyticsResponse::Country }

#device ⇒ Imagekitio::Models::Accounts::UsageAnalyticsResponse::Device

CDN traffic grouped by device and operating system (e.g. Desktop - Apple Mac, Smartphone - Apple iPhone).

Parameters:

  • value (Imagekitio::Accounts::UsageAnalyticsResponse::Device)

Returns:



37
 
# File 'lib/imagekitio/models/accounts/usage_analytics_response.rb', line 37

required :device, -> { Imagekitio::Accounts::UsageAnalyticsResponse::Device }

#end_date ⇒ Date

End date of the computed analytics data.

Parameters:

  • value (Date)

Returns:

  • (Date) 


43
 
# File 'lib/imagekitio/models/accounts/usage_analytics_response.rb', line 43

required :end_date, Date, api_name: :endDate

#error_reasons ⇒ Array<Imagekitio::Models::Accounts::UsageAnalyticsResponse::ErrorReason>

Request count grouped by origin error reason. This covers failed origin fetches, such as an asset not found at origin or an origin timeout. It is not the HTTP status code returned to the client, see statusCodes for that.

Parameters:

  • value (::Array[Imagekitio::Accounts::UsageAnalyticsResponse::ErrorReason])

Returns:



51
52
53
54
55
 
# File 'lib/imagekitio/models/accounts/usage_analytics_response.rb', line 51

required :error_reasons,
-> {
  Imagekitio::Internal::Type::ArrayOf[Imagekitio::Accounts::UsageAnalyticsResponse::ErrorReason]
},
api_name: :errorReasons

#extensions ⇒ Array<Imagekitio::Models::Accounts::UsageAnalyticsResponse::Extension>

Raw per-extension operation counts for the date range. These are raw operation counts, not billable extension units. For billable usage, use the /v1/accounts/usage endpoint.

Parameters:

  • value (::Array[Imagekitio::Accounts::UsageAnalyticsResponse::Extension])

Returns:



63
64
 
# File 'lib/imagekitio/models/accounts/usage_analytics_response.rb', line 63

required :extensions,
-> { Imagekitio::Internal::Type::ArrayOf[Imagekitio::Accounts::UsageAnalyticsResponse::Extension] }

#format_ ⇒ Imagekitio::Models::Accounts::UsageAnalyticsResponse::Format

CDN traffic grouped by response Content-Type.

Parameters:

  • value (Imagekitio::Accounts::UsageAnalyticsResponse::Format)

Returns:



70
 
# File 'lib/imagekitio/models/accounts/usage_analytics_response.rb', line 70

required :format_, -> { Imagekitio::Accounts::UsageAnalyticsResponse::Format }, api_name: :format

#generated_at ⇒ Time

Date and time when the analytics data was computed. Use this to gauge how fresh the returned data is. The date and time is in ISO8601 format.

Parameters:

  • value (Time)

Returns:

  • (Time) 


77
 
# File 'lib/imagekitio/models/accounts/usage_analytics_response.rb', line 77

required :generated_at, Time, api_name: :generatedAt

#request_count ⇒ Float

Total number of requests made during the specified date range.

Parameters:

  • value (Float)

Returns:

  • (Float) 


83
 
# File 'lib/imagekitio/models/accounts/usage_analytics_response.rb', line 83

required :request_count, Float, api_name: :requestCount

#start_date ⇒ Date

Start date of the computed analytics data.

Parameters:

  • value (Date)

Returns:

  • (Date) 


89
 
# File 'lib/imagekitio/models/accounts/usage_analytics_response.rb', line 89

required :start_date, Date, api_name: :startDate

#status_codes ⇒ Array<Imagekitio::Models::Accounts::UsageAnalyticsResponse::StatusCode>

Request count grouped by HTTP status code.

Parameters:

  • value (::Array[Imagekitio::Accounts::UsageAnalyticsResponse::StatusCode])

Returns:



95
96
97
98
99
 
# File 'lib/imagekitio/models/accounts/usage_analytics_response.rb', line 95

required :status_codes,
-> {
  Imagekitio::Internal::Type::ArrayOf[Imagekitio::Accounts::UsageAnalyticsResponse::StatusCode]
},
api_name: :statusCodes

#top404_assets ⇒ Array<Imagekitio::Models::Accounts::UsageAnalyticsResponse::Top404Asset>

Top URLs that returned a 404 response.

Parameters:

  • value (::Array[Imagekitio::Accounts::UsageAnalyticsResponse::Top404Asset])

Returns:



105
106
107
108
109
 
# File 'lib/imagekitio/models/accounts/usage_analytics_response.rb', line 105

required :top404_assets,
-> {
  Imagekitio::Internal::Type::ArrayOf[Imagekitio::Accounts::UsageAnalyticsResponse::Top404Asset]
},
api_name: :top404Assets

#top_image_transforms ⇒ Imagekitio::Models::Accounts::UsageAnalyticsResponse::TopImageTransforms

Top image transformation strings by traffic.

Parameters:

  • value (Imagekitio::Accounts::UsageAnalyticsResponse::TopImageTransforms)

Returns:



125
126
127
 
# File 'lib/imagekitio/models/accounts/usage_analytics_response.rb', line 125

required :top_image_transforms,
-> { Imagekitio::Accounts::UsageAnalyticsResponse::TopImageTransforms },
api_name: :topImageTransforms

#top_images ⇒ Imagekitio::Models::Accounts::UsageAnalyticsResponse::TopImages

Top image assets by traffic.

Parameters:

  • value (Imagekitio::Accounts::UsageAnalyticsResponse::TopImages)

Returns:



115
116
117
118
119
 
# File 'lib/imagekitio/models/accounts/usage_analytics_response.rb', line 115

required :top_images,
-> {
  Imagekitio::Accounts::UsageAnalyticsResponse::TopImages
},
api_name: :topImages

#top_other_assets ⇒ Imagekitio::Models::Accounts::UsageAnalyticsResponse::TopOtherAssets

Top non-image, non-video assets by traffic.

Parameters:

  • value (Imagekitio::Accounts::UsageAnalyticsResponse::TopOtherAssets)

Returns:



133
134
135
 
# File 'lib/imagekitio/models/accounts/usage_analytics_response.rb', line 133

required :top_other_assets,
-> { Imagekitio::Accounts::UsageAnalyticsResponse::TopOtherAssets },
api_name: :topOtherAssets

#top_referrers ⇒ Imagekitio::Models::Accounts::UsageAnalyticsResponse::TopReferrers

Top HTTP referrers by traffic.

Parameters:

  • value (Imagekitio::Accounts::UsageAnalyticsResponse::TopReferrers)

Returns:



141
142
143
 
# File 'lib/imagekitio/models/accounts/usage_analytics_response.rb', line 141

required :top_referrers,
-> { Imagekitio::Accounts::UsageAnalyticsResponse::TopReferrers },
api_name: :topReferrers

#top_user_agents ⇒ Imagekitio::Models::Accounts::UsageAnalyticsResponse::TopUserAgents

Top user agents by traffic.

Parameters:

  • value (Imagekitio::Accounts::UsageAnalyticsResponse::TopUserAgents)

Returns:



149
150
151
 
# File 'lib/imagekitio/models/accounts/usage_analytics_response.rb', line 149

required :top_user_agents,
-> { Imagekitio::Accounts::UsageAnalyticsResponse::TopUserAgents },
api_name: :topUserAgents

#top_video_transforms ⇒ Imagekitio::Models::Accounts::UsageAnalyticsResponse::TopVideoTransforms

Top video transformation strings by traffic.

Parameters:

  • value (Imagekitio::Accounts::UsageAnalyticsResponse::TopVideoTransforms)

Returns:



167
168
169
 
# File 'lib/imagekitio/models/accounts/usage_analytics_response.rb', line 167

required :top_video_transforms,
-> { Imagekitio::Accounts::UsageAnalyticsResponse::TopVideoTransforms },
api_name: :topVideoTransforms

#top_videos ⇒ Imagekitio::Models::Accounts::UsageAnalyticsResponse::TopVideos

Top video assets by traffic.

Parameters:

  • value (Imagekitio::Accounts::UsageAnalyticsResponse::TopVideos)

Returns:



157
158
159
160
161
 
# File 'lib/imagekitio/models/accounts/usage_analytics_response.rb', line 157

required :top_videos,
-> {
  Imagekitio::Accounts::UsageAnalyticsResponse::TopVideos
},
api_name: :topVideos

#url_endpoints ⇒ Imagekitio::Models::Accounts::UsageAnalyticsResponse::URLEndpoints

CDN traffic grouped by configured URL endpoint. Traffic that does not match any named URL endpoint pattern is grouped under Default.

Parameters:

  • value (Imagekitio::Accounts::UsageAnalyticsResponse::URLEndpoints)

Returns:



176
177
178
 
# File 'lib/imagekitio/models/accounts/usage_analytics_response.rb', line 176

required :url_endpoints,
-> { Imagekitio::Accounts::UsageAnalyticsResponse::URLEndpoints },
api_name: :urlEndpoints

#video_processing ⇒ Array<Imagekitio::Models::Accounts::UsageAnalyticsResponse::VideoProcessing>

Raw observed video transcode output duration, in seconds, grouped by resolution and codec. These are raw seconds, not billable Video Processing Units (VPU). For billable VPU totals, use the /v1/accounts/usage endpoint.

Parameters:

  • value (::Array[Imagekitio::Accounts::UsageAnalyticsResponse::VideoProcessing])

Returns:



186
187
188
189
190
 
# File 'lib/imagekitio/models/accounts/usage_analytics_response.rb', line 186

required :video_processing,
-> {
  Imagekitio::Internal::Type::ArrayOf[Imagekitio::Accounts::UsageAnalyticsResponse::VideoProcessing]
},
api_name: :videoProcessing

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


104
 
# File 'sig/imagekitio/models/accounts/usage_analytics_response.rbs', line 104

def to_hash: -> {