statistics

Documentation

Overview

This is an autogenerated file. DO NOT MODIFY

This is an autogenerated file. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Fetch(options *FetchStatisticsOptions) (*FetchStatisticsResponse, error)
  • func (c Client) FetchWithContext(context context.Context, options *FetchStatisticsOptions) (*FetchStatisticsResponse, error)
• type ClientProperties
• type FetchCumulativeStatistics
• type FetchRealTimeStatistics
• type FetchStatisticsBreakdown
• type FetchStatisticsOptions
• type FetchStatisticsResponse
• type FetchWaitTime
• type FetchWaitTimeTasks

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client for managing workflow statistics See https://www.twilio.com/docs/taskrouter/api/workflow-statistics for more details

func New

func New(client *client.Client, properties ClientProperties) *Client

New creates a new instance of the statistics client

func (Client) Fetch

func (c Client) Fetch(options *FetchStatisticsOptions) (*FetchStatisticsResponse, error)

Fetch retrieves statistics See https://www.twilio.com/docs/taskrouter/api/workflow-statistics#workflow-statistics for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) FetchWithContext

func (c Client) FetchWithContext(context context.Context, options *FetchStatisticsOptions) (*FetchStatisticsResponse, error)

FetchWithContext retrieves statistics See https://www.twilio.com/docs/taskrouter/api/workflow-statistics#workflow-statistics for more details

type ClientProperties

type ClientProperties struct {
	WorkflowSid  string
	WorkspaceSid string
}

ClientProperties are the properties required to manage the statistics resources

type FetchCumulativeStatistics

type FetchCumulativeStatistics struct {
	AvgTaskAcceptanceTime     int                       `json:"avg_task_acceptance_time"`
	EndTime                   time.Time                 `json:"end_time"`
	ReservationsAccepted      int                       `json:"reservations_accepted"`
	ReservationsCanceled      int                       `json:"reservations_canceled"`
	ReservationsCompleted     *int                      `json:"reservations_completed,omitempty"`
	ReservationsCreated       int                       `json:"reservations_created"`
	ReservationsRejected      int                       `json:"reservations_rejected"`
	ReservationsRescinded     int                       `json:"reservations_rescinded"`
	ReservationsTimedOut      int                       `json:"reservations_timed_out"`
	ReservationsWrapUp        int                       `json:"reservations_wrapup"`
	SplitByWaitTime           *map[string]FetchWaitTime `json:"split_by_wait_time,omitempty"`
	StartTime                 time.Time                 `json:"start_time"`
	TasksAssigned             *int                      `json:"tasks_assigned,omitempty"`
	TasksCanceled             int                       `json:"tasks_canceled"`
	TasksCompleted            int                       `json:"tasks_completed"`
	TasksDeleted              int                       `json:"tasks_deleted"`
	TasksEntered              int                       `json:"tasks_entered"`
	TasksMoved                int                       `json:"tasks_moved"`
	TasksTimedOutInWorkflow   int                       `json:"tasks_timed_out_in_workflow"`
	WaitDurationUntilAccepted FetchStatisticsBreakdown  `json:"wait_duration_until_accepted"`
	WaitDurationUntilCanceled FetchStatisticsBreakdown  `json:"wait_duration_until_canceled"`
}

type FetchRealTimeStatistics

type FetchRealTimeStatistics struct {
	LongestTaskWaitingAge int            `json:"longest_task_waiting_age"`
	LongestTaskWaitingSid *string        `json:"longest_task_waiting_sid,omitempty"`
	TasksByPriority       map[string]int `json:"tasks_by_priority"`
	TasksByStatus         map[string]int `json:"tasks_by_status"`
	TotalTasks            int            `json:"total_tasks"`
}

type FetchStatisticsBreakdown

type FetchStatisticsBreakdown struct {
	Avg   int `json:"avg"`
	Max   int `json:"max"`
	Min   int `json:"min"`
	Total int `json:"total"`
}

type FetchStatisticsOptions

type FetchStatisticsOptions struct {
	Minutes         *int
	StartDate       *time.Time
	EndDate         *time.Time
	TaskChannel     *string
	SplitByWaitTime *string
}

FetchStatisticsOptions defines the query options for the api operation

type FetchStatisticsResponse

type FetchStatisticsResponse struct {
	AccountSid   string                    `json:"account_sid"`
	Cumulative   FetchCumulativeStatistics `json:"cumulative"`
	RealTime     FetchRealTimeStatistics   `json:"realtime"`
	URL          string                    `json:"url"`
	WorkflowSid  string                    `json:"workflow_sid"`
	WorkspaceSid string                    `json:"workspace_sid"`
}

FetchStatisticsResponse defines the response fields for the retrieved statistics

type FetchWaitTime

type FetchWaitTime struct {
	Above FetchWaitTimeTasks `json:"above"`
	Below FetchWaitTimeTasks `json:"below"`
}

type FetchWaitTimeTasks

type FetchWaitTimeTasks struct {
	ReservationsAccepted int `json:"reservations_accepted"`
	TasksCanceled        int `json:"tasks_canceled"`
}