メニュー

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: Workflow Statistics

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

Workflow Statistics

リソースURI

GET /v1/Workspaces/{WorkspaceSid}/Workflows/{WorkflowSid}/Statistics
        
        
        
        
        パラメーター 概要
        過去最大 'x' 分までの累積統計をフィルタリングします。過去 15 分、240 分(4 時間)、および 480 分(8 時間)の統計を取得してトレンドを見る場合に役に立ちます。初期値は 15 分です。
        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 分が使用されます。

        リアルタイム

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

        フィールド 概要
        LongestTaskWaitingSid 最も長く待機しているTaskのIDです
        LongestTaskWaitingAge 最も長く待機しているTaskの経過時間です
        TotalTasks 総Task数です
        TasksByStatus ステータス別のTask数です(例:pending = 1、reserved = 3、assigned = 2、completed = 5)

        累積

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

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

        Workflowのリアルタイム統計

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

        リソースURI

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

              リアルタイム

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

              フィールド 概要
              LongestTaskWaitingSid 最も長く待機しているTaskのIDです
              LongestTaskWaitingAge 最も長く待機しているTaskの経過時間です
              TotalTasks 総Task数です
              TasksByStatus ステータス別のTask数です(例:pending = 1、reserved = 3、assigned = 2、completed = 5)

              Workflowの累積統計

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

              リソースURI

              GET /v1/Workspaces/{WorkspaceSid}/Workflows/{WorkflowSid}/CumulativeStatistics
              
                    
                    
                    
                    
                    パラメーター 概要
                    過去最大 'x' 分までの累積統計をフィルタリングします。過去 15 分、240 分(4 時間)、および 480 分(8 時間)の統計を取得してトレンドを見る場合に役に立ちます。初期値は 15 分です。
                    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 分が使用されます。

                    累積

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

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

                    ヘルプが必要ですか?

                    We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.