Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::TaskQueueContext::TaskQueueStatisticsContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_statistics.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, workspace_sid, task_queue_sid) ⇒ TaskQueueStatisticsContext

Initialize the TaskQueueStatisticsContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • workspace_sid (String) —

    The workspace_sid

  • task_queue_sid (String) —

    The task_queue_sid



77
78
79
80
81
82
83
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_statistics.rb', line 77

def initialize(version, workspace_sid, task_queue_sid)
  super(version)

  # Path Solution
  @solution = {workspace_sid: workspace_sid, task_queue_sid: task_queue_sid, }
  @uri = "/Workspaces/#{@solution[:workspace_sid]}/TaskQueues/#{@solution[:task_queue_sid]}/Statistics"
end

Instance Method Details

#fetch(end_date: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset) ⇒ TaskQueueStatisticsInstance

Fetch a TaskQueueStatisticsInstance

Parameters:

  • end_date (Time) (defaults to: :unset) —

    Filter cumulative statistics by an end date. This is helpful for defining a range of statistics to capture. Input is a GMT ISO 8601 Timestamp.

  • minutes (String) (defaults to: :unset) —

    Filter cumulative statistics by up to ‘x’ minutes in the past. This is helpful for statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends. Defaults to 15 minutes.

  • start_date (Time) (defaults to: :unset) —

    Filter cumulative statistics by a start date. This is helpful for defining a range of statistics to capture. Input is a GMT ISO 8601 Timestamp.

  • task_channel (String) (defaults to: :unset) —

    Filter real-time and cumulative statistics by TaskChannel. Takes in a Unique Name (“voice”, “sms”, “default”, etc.) or a TaskChannelSid.

  • split_by_wait_time (String) (defaults to: :unset) —

    A comma separated values for viewing splits of tasks canceled and accepted above the given threshold in seconds. Ex: “5,30” would show splits of tasks that were canceled or accepted before or after 5 seconds and respectively, 30 seconds. This is great for showing short abandoned tasks or tasks that failed to meet your SLA.

Returns:



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_statistics.rb', line 105

def fetch(end_date: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset)
  params = Twilio::Values.of({
      'EndDate' => Twilio.serialize_iso8601_datetime(end_date),
      'Minutes' => minutes,
      'StartDate' => Twilio.serialize_iso8601_datetime(start_date),
      'TaskChannel' => task_channel,
      'SplitByWaitTime' => split_by_wait_time,
  })

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  TaskQueueStatisticsInstance.new(
      @version,
      payload,
      workspace_sid: @solution[:workspace_sid],
      task_queue_sid: @solution[:task_queue_sid],
  )
end

#to_s ⇒ Object

Provide a user friendly representation



130
131
132
133
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_statistics.rb', line 130

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Taskrouter.V1.TaskQueueStatisticsContext #{context}>"
end