module SendGrid4r::REST::Stats::Advanced

SendGrid Web API v3 Stats - Advanced

Public Instance Methods

get_browsers_stats( start_date:, end_date: nil, aggregated_by: nil, browsers: nil, &block ) click to toggle source
# File lib/sendgrid4r/rest/stats/advanced.rb, line 93
def get_browsers_stats(
    start_date:,
    end_date: nil,
    aggregated_by: nil,
    browsers: nil,
    &block
)
  params = {
    start_date: start_date,
    end_date: end_date,
    aggregated_by: aggregated_by,
    browsers: browsers
  }
  resp = get(@auth, "#{BASE_URL}/browsers/stats", params, &block)
  finish(resp, @raw_resp) { |r| Stats.create_top_stats(r) }
end
get_clients_stats( start_date:, end_date: nil, aggregated_by: nil, &block ) click to toggle source
# File lib/sendgrid4r/rest/stats/advanced.rb, line 42
def get_clients_stats(
    start_date:,
    end_date: nil,
    aggregated_by: nil,
    &block
)
  params = {
    start_date: start_date,
    end_date: end_date,
    aggregated_by: aggregated_by
  }
  resp = get(@auth, "#{BASE_URL}/clients/stats", params, &block)
  finish(resp, @raw_resp) { |r| Stats.create_top_stats(r) }
end
get_clients_type_stats( start_date:, end_date: nil, aggregated_by: nil, client_type:, &block ) click to toggle source
# File lib/sendgrid4r/rest/stats/advanced.rb, line 57
def get_clients_type_stats(
    start_date:,
    end_date: nil,
    aggregated_by: nil,
    client_type:,
    &block
)
  params = {
    start_date: start_date,
    end_date: end_date,
    aggregated_by: aggregated_by,
    client_type: client_type
  }
  endpoint = "#{BASE_URL}/clients/#{client_type}/stats"
  resp = get(@auth, endpoint, params, &block)
  finish(resp, @raw_resp) { |r| Stats.create_top_stats(r) }
end
get_devices_stats( start_date:, end_date: nil, aggregated_by: nil, &block ) click to toggle source
# File lib/sendgrid4r/rest/stats/advanced.rb, line 27
def get_devices_stats(
    start_date:,
    end_date: nil,
    aggregated_by: nil,
    &block
)
  params = {
    start_date: start_date,
    end_date: end_date,
    aggregated_by: aggregated_by
  }
  resp = get(@auth, "#{BASE_URL}/devices/stats", params, &block)
  finish(resp, @raw_resp) { |r| Stats.create_top_stats(r) }
end
get_geo_stats( start_date:, end_date: nil, aggregated_by: nil, country: nil, &block ) click to toggle source
# File lib/sendgrid4r/rest/stats/advanced.rb, line 10
def get_geo_stats(
    start_date:,
    end_date: nil,
    aggregated_by: nil,
    country: nil,
    &block
)
  params = {
    start_date: start_date,
    end_date: end_date,
    aggregated_by: aggregated_by,
    country: country
  }
  resp = get(@auth, "#{BASE_URL}/geo/stats", params, &block)
  finish(resp, @raw_resp) { |r| Stats.create_top_stats(r) }
end
get_mailbox_providers_stats( start_date:, end_date: nil, aggregated_by: nil, mailbox_providers: nil, &block ) click to toggle source
# File lib/sendgrid4r/rest/stats/advanced.rb, line 75
def get_mailbox_providers_stats(
    start_date:,
    end_date: nil,
    aggregated_by: nil,
    mailbox_providers: nil,
    &block
)
  params = {
    start_date: start_date,
    end_date: end_date,
    aggregated_by: aggregated_by,
    mailbox_providers: mailbox_providers
  }
  endpoint = "#{BASE_URL}/mailbox_providers/stats"
  resp = get(@auth, endpoint, params, &block)
  finish(resp, @raw_resp) { |r| Stats.create_top_stats(r) }
end