Skip to content

OriginInspectorRealtimeApi.md

Latest commit

 

History

History
135 lines (98 loc) · 4.72 KB

OriginInspectorRealtimeApi.md

File metadata and controls

135 lines (98 loc) · 4.72 KB

Fastly::OriginInspectorRealtimeApi

require 'fastly'
api_instance = Fastly::OriginInspectorRealtimeApi.new

Methods

Note

All URIs are relative to https://api.fastly.com

Method HTTP request Description
get_origin_inspector_last120_seconds GET /v1/origins/{service_id}/ts/h Get real-time origin data for the last 120 seconds
get_origin_inspector_last_max_entries GET /v1/origins/{service_id}/ts/h/limit/{max_entries} Get a limited number of real-time origin data entries
get_origin_inspector_last_second GET /v1/origins/{service_id}/ts/{start_timestamp} Get real-time origin data from specific time.

get_origin_inspector_last120_seconds()

get_origin_inspector_last120_seconds(opts): <OriginInspector> # Get real-time origin data for the last 120 seconds

Get data for the 120 seconds preceding the latest timestamp available for a service.

Examples

api_instance = Fastly::OriginInspectorRealtimeApi.new
opts = {
    service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
}

begin
  # Get real-time origin data for the last 120 seconds
  result = api_instance.get_origin_inspector_last120_seconds(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling OriginInspectorRealtimeApi->get_origin_inspector_last120_seconds: #{e}"
end

Options

Name Type Description Notes
service_id String Alphanumeric string identifying the service.

Return type

OriginInspector

[Back to top] [Back to API list] [Back to README]

get_origin_inspector_last_max_entries()

get_origin_inspector_last_max_entries(opts): <OriginInspector> # Get a limited number of real-time origin data entries

Get data for the max_entries seconds preceding the latest timestamp available for a service, up to a maximum of 120 entries.

Examples

api_instance = Fastly::OriginInspectorRealtimeApi.new
opts = {
    service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
    max_entries: 1, # Integer | Maximum number of results to display.
}

begin
  # Get a limited number of real-time origin data entries
  result = api_instance.get_origin_inspector_last_max_entries(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling OriginInspectorRealtimeApi->get_origin_inspector_last_max_entries: #{e}"
end

Options

Name Type Description Notes
service_id String Alphanumeric string identifying the service.
max_entries Integer Maximum number of results to display.

Return type

OriginInspector

[Back to top] [Back to API list] [Back to README]

get_origin_inspector_last_second()

get_origin_inspector_last_second(opts): <OriginInspector> # Get real-time origin data from specific time.

Get real-time origin data for the specified reporting period. Specify 0 to get a single entry for the last complete second. The Timestamp field included in the response provides the time index of the latest entry in the dataset and can be provided as the start_timestamp of the next request for a seamless continuation of the dataset from one request to the next. Due to processing latency, the earliest entry in the response dataset may be earlier than start_timestamp by the value of AggregateDelay.

Examples

api_instance = Fastly::OriginInspectorRealtimeApi.new
opts = {
    service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
    start_timestamp: 56, # Integer | Timestamp in seconds (Unix epoch time).
}

begin
  # Get real-time origin data from specific time.
  result = api_instance.get_origin_inspector_last_second(opts)
  p result
rescue Fastly::ApiError => e
  puts "Error when calling OriginInspectorRealtimeApi->get_origin_inspector_last_second: #{e}"
end

Options

Name Type Description Notes
service_id String Alphanumeric string identifying the service.
start_timestamp Integer Timestamp in seconds (Unix epoch time).

Return type

OriginInspector

[Back to top] [Back to API list] [Back to README]