メニュー

Expand
Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

REST API: TaskQueue Statistics

TaskRouterは、TaskQueueに関するリアルタイムと履歴の統計を提供します。

TaskQueueインスタンス統計

リソースURI

GET /v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/Statistics
        
        
        
        
        パラメーター 概要
        過去最大 'x' 分までの累積統計をフィルタリングします。過去 15 分、240 分(4 時間)、および 480 分(8 時間)の統計を取得してトレンドを見る場合に役に立ちます。初期値は 15 分です。
        FriendlyName TaskQueueの名前に基づいて、TaskQueue Statisticsをフィルタリングします(リストリソースの場合のみ)。
        StartDate 開始日で累積統計をフィルタリングします。取得する統計の範囲を定義するのに役立ちます。GMT ISO 8601 フォーマット で入力します。
        EndDate 終了日で累積統計をフィルタリングします。取得する統計の範囲を定義するのに役立ちます。GMT ISO 8601 フォーマット で入力します。
        TaskChannel リアルタイムまたは累積の統計をTaskChannelごとにフィルタリングします。 一意な名前 (「voice」、「sms」、「default」、など) または TaskChannelSid を取ります。
        SplitByWaitTime 秒数で指定されたしきい値を超える、キャンセルまたは承諾されたTaskの分割を表示するためのカンマ区切りの値です。 たとえば「5,30」と指定すると、5秒前 (後) および30秒前 (後) にキャンセルまたは承諾されたTaskの分割を表示します。 これは短い放棄TaskまたはSLAを満たせなかったTaskを表示する用途に最適です。

        注:StartDate パラメーターと EndDate パラメーターと一緒に Minutes を使用することはできません。パラメーターが 1 つも渡されない場合、初期値として 15 分が使用されます。

        リアルタイム

        TaskQueueに関連するリアルタイム統計には、次が含まれます。

        フィールド 概要
        LongestTaskWaitingSid 最も長く待機しているTaskのIDです
        LongestTaskWaitingAge 最も長く待機しているTaskの経過時間です
        TotalTasks 総Task数です
        TasksByStatus ステータス別のTask数です(例:pending = 1、reserved = 3、assigned = 2、completed = 5)
        TasksByPriority 優先順位によって分類されたTaskです (例: 0: 10, 99:5)
        ActivityStatistics Activity別の現在のWorkerステータス数です。
        TotalEligibleWorkers The total number of Workers eligible for Tasks in this TaskQueue, irrespective of Activity state.
        TotalAvailableWorkers このTaskQueueに入っているTaskに使用可能なWorkerの総数です。

        累積

        TaskQueueに関連する一定期間における累積統計には、次が含まれます。

        フィールド 概要
        TasksEntered このTaskQueueに入ってきたTaskの総数です。
        TasksCanceled このTaskQueueに入っている間にキャンセルされたTaskの総数です。
        TasksCompleted このTaskQueue内に滞留中に完了したTaskの総数です
        TasksDeleted このTaskQueueに入っている間に削除されたTaskの総数です。
        TasksMoved このTaskQueueから別のTaskQueueに移動したTaskの総数です。
        AvgTaskAcceptanceTime このTaskQueue内における、Taskの作成からReservationが受諾されるまでの平均時間を秒数返します
        ReservationsCreated このTaskQueueに入っているTaskに対して作成されたReservationの総数です。
        ReservationsAccepted このTaskQueueに入っているTaskの受諾されたReservationの総数です。
        ReservationsRejected このTaskQueueに入っているTaskの拒否されたReservationの総数です。
        ReservationsTimedOut このTaskQueueに入っているTaskのタイムアウトしたReservationの総数です。
        ReservationsCanceled このTaskQueueに入っているTaskのキャンセルされたReservationの総数です。
        ReservationsRescinded 撤回されたReservationの総数です
        WaitDurationUntilCanceled このTaskQueue内における、キャンセルされたTaskに対する待ち時間の統計 (平均、最小、最大、合計) です
        WaitDurationUntilAccepted このTaskQueue内における、受諾されたTaskに対する待ち時間の統計 (平均、最小、最大、合計) です
        SplitByWaitTime SplitByWaitTimeパラメーターによる指定に基づく、キャンセルまたは受諾されたTaskの差異です。

        TaskQueue RealTime 統計

        TaskQueueのリアルタイムの統計のみが問題になる場合は、下記のエンドポイントが使用できます。

        リソースURI

        GET /v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/RealTimeStatistics
        
              
              
              
              
              パラメーター 概要
              TaskChannel リアルタイム統計をTaskChannelごとにフィルタリングします。 一意な名前 (「voice」、「sms」、「default」、など) または TaskChannelSid を取ります。

              リアルタイム

              TaskQueueに関連するリアルタイム統計には、次が含まれます。

              フィールド 概要
              LongestTaskWaitingSid 最も長く待機しているTaskのIDです
              LongestTaskWaitingAge 最も長く待機しているTaskの経過時間です
              TotalTasks 総Task数です
              TasksByStatus ステータス別のTask数です(例:pending = 1、reserved = 3、assigned = 2、completed = 5)
              TasksByPriority 優先順位によって分類されたTaskです (例: 0: 10, 99:5)
              ActivityStatistics Activity別の現在のWorkerステータス数です。
              TotalEligibleWorkers The total number of Workers eligible for Tasks in this TaskQueue, irrespective of Activity state.
              TotalAvailableWorkers このTaskQueueに入っているTaskに使用可能なWorkerの総数です。

              TaskQueueの累積統計

              特定の期間における累積統計のみが問題になる場合は、下記のエンドポイントが使用できます。

              リソースURI

              GET /v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/CumulativeStatistics
              
                    
                    
                    
                    
                    パラメーター 概要
                    過去最大 'x' 分までの累積統計をフィルタリングします。過去 15 分、240 分(4 時間)、および 480 分(8 時間)の統計を取得してトレンドを見る場合に役に立ちます。初期値は 15 分です。
                    FriendlyName TaskQueueの名前に基づいて、TaskQueue Statisticsをフィルタリングします(リストリソースの場合のみ)。
                    StartDate 開始日で累積統計をフィルタリングします。取得する統計の範囲を定義するのに役立ちます。GMT ISO 8601 フォーマット で入力します。
                    EndDate 終了日で累積統計をフィルタリングします。取得する統計の範囲を定義するのに役立ちます。GMT ISO 8601 フォーマット で入力します。
                    TaskChannel 累積統計をTaskChannelごとにフィルタリングします。 一意な名前 (「voice」、「sms」、「default」、など) または TaskChannelSid を取ります。
                    SplitByWaitTime 秒数で指定されたしきい値を超える、キャンセルまたは承諾されたTaskの分割を表示するためのカンマ区切りの値です。 たとえば「5,30」と指定すると、5秒前 (後) および30秒前 (後) にキャンセルまたは承諾されたTaskの分割を表示します。 これは短い放棄TaskまたはSLAを満たせなかったTaskを表示する用途に最適です。

                    注:StartDate パラメーターと EndDate パラメーターと一緒に Minutes を使用することはできません。パラメーターが 1 つも渡されない場合、初期値として 15 分が使用されます。

                    累積

                    TaskQueueに関連する一定期間における累積統計には、次が含まれます。

                    フィールド 概要
                    TasksEntered このTaskQueueに入ってきたTaskの総数です。
                    TasksCanceled このTaskQueueに入っている間にキャンセルされたTaskの総数です。
                    TasksCompleted このTaskQueue内に滞留中に完了したTaskの総数です
                    TasksDeleted このTaskQueueに入っている間に削除されたTaskの総数です。
                    TasksMoved このTaskQueueから別のTaskQueueに移動したTaskの総数です。
                    AvgTaskAcceptanceTime このTaskQueue内における、Taskの作成からReservationが受諾されるまでの平均時間を秒数返します
                    ReservationsCreated このTaskQueueに入っているTaskに対して作成されたReservationの総数です。
                    ReservationsAccepted このTaskQueueに入っているTaskの受諾されたReservationの総数です。
                    ReservationsRejected このTaskQueueに入っているTaskの拒否されたReservationの総数です。
                    ReservationsTimedOut このTaskQueueに入っているTaskのタイムアウトしたReservationの総数です。
                    ReservationsCanceled このTaskQueueに入っているTaskのキャンセルされたReservationの総数です。
                    ReservationsRescinded 撤回されたReservationの総数です
                    WaitDurationUntilCanceled このTaskQueue内における、キャンセルされたTaskに対する待ち時間の統計 (平均、最小、最大、合計) です
                    WaitDurationUntilAccepted このTaskQueue内における、受諾されたTaskに対する待ち時間の統計 (平均、最小、最大、合計) です
                    SplitByWaitTime このTaskQueue内における、SplitByWaitTimeパラメーターによる指定に基づく、キャンセルまたは受諾されたTaskの差異です
                    Rate this page:

                    ヘルプが必要ですか?

                    誰しもが一度は考える「コーディングって難しい」。そんな時は、お問い合わせフォームから質問してください。 または、Stack Overflow でTwilioタグのついた情報から欲しいものを探してみましょう。