Skip to content

Latest commit

 

History

History
173 lines (121 loc) · 5.25 KB

StatisticsApi.md

File metadata and controls

173 lines (121 loc) · 5.25 KB

TelstraTPN::StatisticsApi

All URIs are relative to https://penapi.pacnetconnect.com

Method HTTP request Description
inventory_links_stats_endpoint GET /1.0.0/inventory/links-stats/endpoint/{endpointuuid}/{startdate}/{enddate} Get statistics for endpoint
inventory_links_stats_endpointstate GET /1.0.0/inventory/links-stats/endpointstate/{endpointuuid}/{startdate}/{enddate} Get state statistics for endpoint
inventory_links_stats_flow GET /1.0.0/inventory/links-stats/flow/{linkid}/{startdate}/{enddate} Get statistics for flow

inventory_links_stats_endpoint

Array<InlineResponse20018> inventory_links_stats_endpoint(endpointuuid, startdate, enddate)

Get statistics for endpoint

Get statistics related to the specified endpoint

Example

# load the gem
require 'TelstraTPN'
# setup authorization
TelstraTPN.configure do |config|
  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = TelstraTPN::StatisticsApi.new
endpointuuid = 'endpointuuid_example' # String | Unique identifier representing a specific endpoint
startdate = 'startdate_example' # String | Start date for statistics query
enddate = 'enddate_example' # String | End date for statistics query

begin
  #Get statistics for endpoint
  result = api_instance.inventory_links_stats_endpoint(endpointuuid, startdate, enddate)
  p result
rescue TelstraTPN::ApiError => e
  puts "Exception when calling StatisticsApi->inventory_links_stats_endpoint: #{e}"
end

Parameters

Name Type Description Notes
endpointuuid String Unique identifier representing a specific endpoint
startdate String Start date for statistics query
enddate String End date for statistics query

Return type

Array<InlineResponse20018>

Authorization

oAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

inventory_links_stats_endpointstate

Array<InlineResponse20020> inventory_links_stats_endpointstate(endpointuuid, startdate, enddate)

Get state statistics for endpoint

Get statistics related to the state of the specified endpoint

Example

# load the gem
require 'TelstraTPN'
# setup authorization
TelstraTPN.configure do |config|
  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = TelstraTPN::StatisticsApi.new
endpointuuid = 'endpointuuid_example' # String | Unique identifier representing a specific endpoint
startdate = 'startdate_example' # String | Start date for statistics query
enddate = 'enddate_example' # String | End date for statistics query

begin
  #Get state statistics for endpoint
  result = api_instance.inventory_links_stats_endpointstate(endpointuuid, startdate, enddate)
  p result
rescue TelstraTPN::ApiError => e
  puts "Exception when calling StatisticsApi->inventory_links_stats_endpointstate: #{e}"
end

Parameters

Name Type Description Notes
endpointuuid String Unique identifier representing a specific endpoint
startdate String Start date for statistics query
enddate String End date for statistics query

Return type

Array<InlineResponse20020>

Authorization

oAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

inventory_links_stats_flow

Array<InlineResponse20019> inventory_links_stats_flow(linkid, startdate, enddate)

Get statistics for flow

Get statistics related to the specified flow

Example

# load the gem
require 'TelstraTPN'
# setup authorization
TelstraTPN.configure do |config|
  # Configure OAuth2 access token for authorization: oAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = TelstraTPN::StatisticsApi.new
linkid = 'linkid_example' # String | Unique identifier representing a specific link
startdate = 'startdate_example' # String | Start date for statistics query
enddate = 'enddate_example' # String | End date for statistics query

begin
  #Get statistics for flow
  result = api_instance.inventory_links_stats_flow(linkid, startdate, enddate)
  p result
rescue TelstraTPN::ApiError => e
  puts "Exception when calling StatisticsApi->inventory_links_stats_flow: #{e}"
end

Parameters

Name Type Description Notes
linkid String Unique identifier representing a specific link
startdate String Start date for statistics query
enddate String End date for statistics query

Return type

Array<InlineResponse20019>

Authorization

oAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json