Class: ApolloDeploySignalSdkRails::Metrics

Inherits:
Object
  • Object
show all
Defined in:
lib/apollo_deploy_signal_sdk_rails/resources/metrics.rb

Overview

metrics API domain

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ Metrics

Returns a new instance of Metrics.



11
12
13
 
# File 'lib/apollo_deploy_signal_sdk_rails/resources/metrics.rb', line 11

def initialize(transport)
  @transport = transport
end

Instance Attribute Details

#transport ⇒ Object (readonly)

Returns the value of attribute transport.



9
10
11
 
# File 'lib/apollo_deploy_signal_sdk_rails/resources/metrics.rb', line 9

def transport
  @transport
end

Instance Method Details

#get_email_engagement(id:) ⇒ EmailReadScrollAnalyticsResponse

Parameters:

  • id (String)

Returns:

Raises:



56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/apollo_deploy_signal_sdk_rails/resources/metrics.rb', line 56

def get_email_engagement(id:)
  path_params = {
    "id" => id,
  }

  transport.request(
    method: :get,
    path: "/v1/metrics/emails/${id}/engagement",
    path_params: path_params,
    timeout_ms: nil,
  )
end

#get_email_performance(id:) ⇒ EmailPerformanceResponse

Parameters:

  • id (String)

Returns:

Raises:



40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/apollo_deploy_signal_sdk_rails/resources/metrics.rb', line 40

def get_email_performance(id:)
  path_params = {
    "id" => id,
  }

  transport.request(
    method: :get,
    path: "/v1/metrics/emails/${id}",
    path_params: path_params,
    timeout_ms: nil,
  )
end

#get_metrics_advisor(query: nil) ⇒ AdvisorReportResponse

Parameters:

  • query (Hash, nil) (defaults to: nil) —

    query parameters

Returns:

Raises:



108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/apollo_deploy_signal_sdk_rails/resources/metrics.rb', line 108

def get_metrics_advisor(query: nil)
  query_params = {}
  query_params["projectId"] = query[:project_id] if query && query.key?(:project_id)
  query_params = nil if query_params.empty?

  transport.request(
    method: :get,
    path: "/v1/metrics/advisor",
    query: query_params,
    timeout_ms: nil,
  )
end

#get_project_metrics_summary(query: nil) ⇒ ProjectMetricsSummaryResponse

Parameters:

  • query (Hash, nil) (defaults to: nil) —

    query parameters

Returns:

Raises:



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/apollo_deploy_signal_sdk_rails/resources/metrics.rb', line 72

def get_project_metrics_summary(query: nil)
  query_params = {}
  query_params["window"] = query[:window] if query && query.key?(:window)
  query_params["projectId"] = query[:project_id] if query && query.key?(:project_id)
  query_params = nil if query_params.empty?

  transport.request(
    method: :get,
    path: "/v1/metrics/summary",
    query: query_params,
    timeout_ms: nil,
  )
end

#get_project_metrics_timeline(query: nil) ⇒ ProjectMetricsTimelineResponse

Parameters:

  • query (Hash, nil) (defaults to: nil) —

    query parameters

Returns:

Raises:



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/apollo_deploy_signal_sdk_rails/resources/metrics.rb', line 89

def get_project_metrics_timeline(query: nil)
  query_params = {}
  query_params["window"] = query[:window] if query && query.key?(:window)
  query_params["granularity"] = query[:granularity] if query && query.key?(:granularity)
  query_params["format"] = query[:format] if query && query.key?(:format)
  query_params["projectId"] = query[:project_id] if query && query.key?(:project_id)
  query_params = nil if query_params.empty?

  transport.request(
    method: :get,
    path: "/v1/metrics/timeline",
    query: query_params,
    timeout_ms: nil,
  )
end

#get_topic_performance(id:, query: nil) ⇒ TopicPerformanceResponse

Parameters:

  • id (String)
  • query (Hash, nil) (defaults to: nil) —

    query parameters

Returns:

Raises:



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/apollo_deploy_signal_sdk_rails/resources/metrics.rb', line 19

def get_topic_performance(id:, query: nil)
  path_params = {
    "id" => id,
  }
  query_params = {}
  query_params["window"] = query[:window] if query && query.key?(:window)
  query_params["projectId"] = query[:project_id] if query && query.key?(:project_id)
  query_params = nil if query_params.empty?

  transport.request(
    method: :get,
    path: "/v1/metrics/topics/${id}",
    path_params: path_params,
    query: query_params,
    timeout_ms: nil,
  )
end