class Dogapi::V1::EmbedService
¶ ↑
EMBED API
¶ ↑
Constants
- API_VERSION
Public Instance Methods
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, line 54 def create_embed(graph_json, description= {}) begin params = { :api_key => @api_key, :application_key => @application_key } body = { :graph_json => graph_json, }.merge(description) request(Net::HTTP::Post, "/api/#{API_VERSION}/graph/embed", params, body, true) rescue Exception => e suppress_error_if_silent e end end
Enable a specific embed
:embed_id => String: embed token for a specific embed
# File lib/dogapi/v1/embed.rb, line 74 def enable_embed(embed_id) begin params = { :api_key => @api_key, :application_key => @application_key } request(Net::HTTP::Get, "/api/#{API_VERSION}/graph/embed/#{embed_id}/enable", params, nil, false) rescue Exception => e suppress_error_if_silent e end end
Get all embeds for the API user's org
# File lib/dogapi/v1/embed.rb, line 14 def get_all_embeds() begin params = { :api_key => @api_key, :application_key => @application_key } request(Net::HTTP::Get, "/api/#{API_VERSION}/graph/embed", params, nil, false) rescue Exception => e suppress_error_if_silent e end end
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, line 33 def get_embed(embed_id, description= {}) begin # Initialize parameters and merge with description params = { :api_key => @api_key, :application_key => @application_key, }.merge(description) request(Net::HTTP::Get, "/api/#{API_VERSION}/graph/embed/#{embed_id}", params, nil, false) rescue Exception => e suppress_error_if_silent e end end
Revoke a specific embed
:embed_id => String: embed token for a specific embed
# File lib/dogapi/v1/embed.rb, line 90 def revoke_embed(embed_id) begin params = { :api_key => @api_key, :application_key => @application_key } request(Net::HTTP::Get, "/api/#{API_VERSION}/graph/embed/#{embed_id}/revoke", params, nil, false) rescue Exception => e suppress_error_if_silent e end end