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 FetchActivityDuration
• type FetchCumulativeStatistics
• type FetchStatisticsOptions
• type FetchStatisticsResponse

Types

type Client

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

Client for managing all worker statistics See https://www.twilio.com/docs/taskrouter/api/worker/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/worker/statistics#fetch-a-specific-workers-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/worker/statistics#fetch-a-specific-workers-statistics for more details

type ClientProperties

type ClientProperties struct {
	WorkerSid    string
	WorkspaceSid string
}

ClientProperties are the properties required to manage the statistics resources

type FetchActivityDuration

type FetchActivityDuration struct {
	Avg          int    `json:"avg"`
	FriendlyName string `json:"friendly_name"`
	Max          int    `json:"max"`
	Min          int    `json:"min"`
	Sid          string `json:"sid"`
	Total        int    `json:"total"`
}

type FetchCumulativeStatistics

type FetchCumulativeStatistics struct {
	ActivityDurations     []FetchActivityDuration `json:"activity_durations"`
	EndTime               time.Time               `json:"end_time"`
	ReservationsAccepted  int                     `json:"reservations_accepted"`
	ReservationsCanceled  int                     `json:"reservations_canceled"`
	ReservationsCompleted int                     `json:"reservations_completed"`
	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"`
	StartTime             time.Time               `json:"start_time"`
	TasksAssigned         int                     `json:"tasks_assigned"`
}

type FetchStatisticsOptions

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

FetchStatisticsOptions defines the query options for the api operation

type FetchStatisticsResponse

type FetchStatisticsResponse struct {
	AccountSid   string                    `json:"account_sid"`
	Cumulative   FetchCumulativeStatistics `json:"cumulative"`
	URL          string                    `json:"url"`
	WorkerSid    string                    `json:"worker_sid"`
	WorkspaceSid string                    `json:"workspace_sid"`
}

FetchStatisticsResponse defines the response fields for the retrieved statistics