class Dogapi::V1::EmbedService

EMBED API

Constants

API_VERSION

Public Instance Methods

create_embed(graph_json, description= {}) click to toggle source

Create an embeddable graph

:graph_json => JSON: graph definition :timeframe => String: representing the interval of the graph. Default is “1_hour” :size => String: representing the size of the graph. Default is “medium”. :legend => String: flag representing whether a legend is displayed. Default is “no”. :title => String: represents title of the graph. Default is “Embed created through API.”

   # File lib/dogapi/v1/embed.rb
37 def create_embed(graph_json, description= {})
38   body = {
39     :graph_json => graph_json,
40   }.merge(description)
41 
42   request(Net::HTTP::Post, "/api/#{API_VERSION}/graph/embed", nil, body, true)
43 end
enable_embed(embed_id) click to toggle source

Enable a specific embed

:embed_id => String: embed token for a specific embed

   # File lib/dogapi/v1/embed.rb
48 def enable_embed(embed_id)
49   request(Net::HTTP::Get, "/api/#{API_VERSION}/graph/embed/#{embed_id}/enable", nil, nil, false)
50 end
get_all_embeds() click to toggle source

Get all embeds for the API user's org

   # File lib/dogapi/v1/embed.rb
16 def get_all_embeds()
17   request(Net::HTTP::Get, "/api/#{API_VERSION}/graph/embed", nil, nil, false)
18 end
get_embed(embed_id, description= {}) click to toggle source

Get a specific embed

:embed_id => String: embed token for a specific embed :size => String: “small”, “medium”(defualt), “large”, or “xlarge”. :legend => String: “yes” or “no”(default) :template_vars => String: variable name => variable value (any number of template vars)

   # File lib/dogapi/v1/embed.rb
26 def get_embed(embed_id, description= {})
27   request(Net::HTTP::Get, "/api/#{API_VERSION}/graph/embed/#{embed_id}", description, nil, false)
28 end
revoke_embed(embed_id) click to toggle source

Revoke a specific embed

:embed_id => String: embed token for a specific embed

   # File lib/dogapi/v1/embed.rb
55 def revoke_embed(embed_id)
56   request(Net::HTTP::Get, "/api/#{API_VERSION}/graph/embed/#{embed_id}/revoke", nil, nil, false)
57 end