Yay.com loading

Loading

Error Sorry

0

Shopping Basket

Basket Total

$0.00

incVAT

Delete everything from your basket?

Go to Checkout

Queue Stats

Request the stats for a particular call queue

Become a Reseller

Filter:

  • All
  • GET
  • POST
  • PUT
  • DELETE
  • Chargeable *

* You will be charged every time this command is run.

  • GET/voip/queue-group/{uuid}/stats?start={start}&end={end}&include_stats={include_stats}&include_user_stats={include_user_stats}&interval={interval}&include_records={include_records}&limit={limit}&page={page}

    Gets the stats for the given queue group

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • start

      • Date

      • True

      The start of the date range to search on, e.g. 2019-05-31T9:00:00

      • end

      • Date

      • False

      The end of the date range to search on, e.g. 2019-05-31T17:00:00

      • include_stats

      • Boolean

      • False

      Should the summary stats be included in the response

      • include_user_stats

      • Boolean

      • False

      Should the user breakdown stats be included in the response

      • interval

      • enum

      • False

      Include a summary per time interval in the response. Valid intervals are: 'year', 'quarter', 'month', 'week', 'hour', 'minute'

      • include_records

      • Boolean

      • False

      Should the individual call details be included in the response

      • limit

      • int

      • False

      How many records to return per page: default 20

      • page

      • int

      • False

      Which page of records to return: default 1

    Response Details

    200 Response

    {
        "result" : [
            {
                "in_queue" : 5,
                "records" : {
                    "limit" : 20,
                    "page" : 1,
                    "records" : [
                        {
                            "answer" : "2019-05-31T12:00:27Z",
                            "answer_by" : "00001111-2233-4567-8888-999999aaaaaa",
                            "call_duration" : 1593,
                            "cdr" : "00001111-2233-4567-8888-999aaabbbccc",
                            "disposition" : "answered",
                            "duration" : 1620,
                            "end" : "2019-05-31T12:27:00Z",
                            "queue_id" : "00001111-2233-4567-8888-999999999999",
                            "ready" : "2019-05-31T12:00:20Z",
                            "ring_duration" : 7,
                            "start" : "2019-05-31T12:00:00Z",
                            "uuid" : "00001111-2233-4567-8888-9999aaaabbbb",
                            "wait_duration" : 20
                        }
                    ],
                    "total_pages" : 5
                },
                "stats" : {
                    "average_call_duration" : 150.0,
                    "average_duration" : 270.0,
                    "average_ring_duration" : 40.0,
                    "average_wait_duration" : 80.0,
                    "max_call_duration" : 500,
                    "max_duration" : 1000,
                    "max_ring_duration" : 60,
                    "max_wait_duration" : 180,
                    "num_abandoned" : 2,
                    "num_answered" : 80,
                    "num_calls" : 100,
                    "num_noregistered" : 0,
                    "num_ongoing" : 10,
                    "num_ringing" : 3,
                    "num_shortcode" : 0,
                    "num_timeout" : 5,
                    "total_call_duration" : 15000,
                    "total_duration" : 27000,
                    "total_ring_duration" : 4000,
                    "total_wait_duration" : 8000
                },
                "time_stats" : [
                    {
                        "average_call_duration" : 190.0,
                        "average_duration" : 270.0,
                        "average_ring_duration" : 20.0,
                        "average_wait_duration" : 60.0,
                        "max_call_duration" : 1593,
                        "max_duration" : 1620,
                        "max_ring_duration" : 60,
                        "max_wait_duration" : 180,
                        "num_abandoned" : 0,
                        "num_answered" : 8,
                        "num_calls" : 10,
                        "num_noregistered" : 0,
                        "num_ongoing" : 1,
                        "num_ringing" : 1,
                        "num_shortcode" : 0,
                        "num_timeout" : 0,
                        "time" : "2019-05-31T09:00:00",
                        "total_call_duration" : 1900,
                        "total_duration" : 2700,
                        "total_ring_duration" : 200,
                        "total_wait_duration" : 600
                    }
                ],
                "user_stats" : {
                    "00001111-2233-4567-8888-999999aaaaaa" : {
                        "average_call_duration" : 190.0,
                        "average_duration" : 270.0,
                        "average_ring_duration" : 20.0,
                        "average_wait_duration" : 60.0,
                        "last_call_answer" : "2019-05-31T12:00:27Z",
                        "last_call_end" : "2019-05-31T12:27:00Z",
                        "last_call_start" : "2019-05-31T12:00:00Z",
                        "max_call_duration" : 1593,
                        "max_duration" : 1620,
                        "max_ring_duration" : 60,
                        "max_wait_duration" : 180,
                        "num_abandoned" : 0,
                        "num_answered" : 0,
                        "num_calls" : 10,
                        "num_noregistered" : 0,
                        "num_ongoing" : 0,
                        "num_ringing" : 0,
                        "num_shortcode" : 0,
                        "num_timeout" : 0,
                        "status" : "unavailable",
                        "total_call_duration" : 1900,
                        "total_duration" : 2700,
                        "total_ring_duration" : 200,
                        "total_wait_duration" : 600,
                        "user_uuid" : "00001111-2233-4567-8888-999999aaaaaa"
                    }
                }
            }
        ],
        "status_code" : 200,
        "status_message" : "OK"
    }

    400 Response

    {
        "result" : {},
        "status_code" : 400,
        "status_message" : "Bad Request"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
ISO 27001 Business Continuity Accreditation ISO 22301 Business Continuity Accreditation Cyber Essentials Certificate of Assurance G-Cloud accredited by the Crown Commercial Service