Class: Public::Dashboards

Inherits:
Object
  • Object
show all
Defined in:
lib/grafana-api/api/public/dashboards.rb

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ Dashboards

Returns a new instance of Dashboards.



5
6
7
 
# File 'lib/grafana-api/api/public/dashboards.rb', line 5

def initialize(connection)
  @connection = connection
end

Instance Method Details

#annotations(access_token:) ⇒ Object

Raises:

  • (ArgumentError) 


9
10
11
12
13
14
15
16
17
18
19
 
# File 'lib/grafana-api/api/public/dashboards.rb', line 9

def annotations(access_token:)
  raise ArgumentError, 'access_token is required' if access_token.nil?

  @connection.call(
    :GET,
    '/public/dashboards/{accessToken}/annotations'
      .gsub('{accessToken}', ERB::Util.url_encode(access_token.to_s)),
    type: [Grafana::Api::Models::AnnotationEvent],
    auth: ['api_key', 'basic']
  )
end

#get(access_token:) ⇒ Object

Raises:

  • (ArgumentError) 


21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/grafana-api/api/public/dashboards.rb', line 21

def get(access_token:)
  raise ArgumentError, 'access_token is required' if access_token.nil?

  @connection.call(
    :GET,
    '/public/dashboards/{accessToken}'
      .gsub('{accessToken}', ERB::Util.url_encode(access_token.to_s)),
    type: Grafana::Api::Models::DashboardFullWithMeta,
    auth: ['api_key', 'basic']
  )
end

#panels_query(access_token:, panel_id:) ⇒ Object

Raises:

  • (ArgumentError) 


33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/grafana-api/api/public/dashboards.rb', line 33

def panels_query(access_token:, panel_id:)
  raise ArgumentError, 'access_token is required' if access_token.nil?
  raise ArgumentError, 'panel_id is required' if panel_id.nil?

  @connection.call(
    :POST,
    '/public/dashboards/{accessToken}/panels/{panelId}/query'
      .gsub('{accessToken}', ERB::Util.url_encode(access_token.to_s))
      .gsub('{panelId}', ERB::Util.url_encode(panel_id.to_s)),
    type: Grafana::Api::Models::QueryDataResponse,
    auth: ['api_key', 'basic']
  )
end