.. _arbitrator-API-resources-ciscocdr:


ciscocdr 
----------

The ``ciscocdr`` resource supports the following operations. 

.. tabularcolumns:: |p{1.5cm}|p{5cm}|p{8.5cm}|

+--------+---------------+--------------------------------------------+
| Method | URL           | Description                                |
+========+===============+============================================+
| GET    | ``/ciscocdr`` | Get running totals for ``ciscocdr`` stats. |
+--------+---------------+--------------------------------------------+


GET
........

* Query Parameters 


  Query parameters are only used with GET requests and can be appended to the URL with a ``?`` sign.
  
  ``cm_ip`` - Optional query parameter. If provided, the total stats returned will only be for the specific
  Call Manager.
  
  .. note::
    
     ``cm_ip`` can be an actual IP address or a free form string. 
  
  Example:
  
  
  ``/ciscocdr?cm_ip=10.13.37.11``

  ``/ciscocdr?cm_ip=customer_a`` 
  

* Response Codes 

	
  .. tabularcolumns:: |p{5cm}|p{5cm}|

  +------------------+---------+
  | HTTP Status Code | Reason  |
  +==================+=========+
  | 200              | Success |
  +------------------+---------+

  
* Example Output 

  Command:

  ::

    curl -k -w '\nRESP_CODE: %{response_code}\n' 
         -X GET https://10.13.37.12/api/ciscocdr 

  Output (abbreviated): 

  ::

     {"ciscocdrs":
       {"call_stats":{"total_call_attempts":9003512,
           "total_audio_calls":9002735,
           "total_video_calls":777,
           "total_conferences":15783,
           "total_audio_conferences":15783,
           "total_video_conferences":0,
           "tota  l_abandoned_calls":877955,
           "total_completed_calls":14103104,
           "total_connected_calls":576162,
           "total_failed_calls":1066745,
           "total_processed_calls":8938909,
           "total_rejected_calls":  64603,
           "total_short_calls":19181,
           "total_minutes":34970017.2,
           "total_video_minutes":9132.3833333333,
           "total_audio_minutes":32397357.666667,
           "lower_timestamp":0,
           "upper_timestamp":0,
           "average_hold_time":718,
           "erlangs":42679.134722222,
           "grade_of_service":0,
           "call_failure_ratio":0,
           "total_mobile_calls":7,
           "total_mobile_orig_calls":0,
           "total_mobile_dest_calls":7,
           "total_mobile_minutes":0.45,
           "total_mobile_orig_minutes":266.91666666667,
           "total_mobile_dest_minutes":266.91666666667,
           "total_split_calls":103485,
           "total_split_minutes":214988.7} ,

  ::

        "mos_stats":{
             "excellent":{"count":0, "duration":0},
             "good":{"count":2601813, "duration":82398665},
             "fair":{"count":1873602, "duration":74861679},
             "poor":{"count":14932, "duration":2273635},
             "bad":{"count":0, "duration":0},
             "unknown":{"count":2474100, "duration":19864626}
            },

  ::

        "metric_stats":{"numberPacketsSent":{"avg":12087.783361046, "count":6920916, "max":47033496, "min":2, "sum":83658533268},
            "numberOctetsSent":{"avg":1217508.3804676, "count":6920916, "max":740301392, "min":-667814800, "sum":842627323 0512},
            "numberPacketsReceived":{"avg":11824.050579865, "count":6920916, "max":2375697, "min":1, "sum":81833260843},
            "numberOctetsReceived":{"avg":1416922.0078419, "count":6920916, "max":2147483647, "min":32, "sum":9806398194825},
            "numberPacketsLost":{"avg":48407.375317516, "count":6920916, "max":2147483647, "min":-65536, "sum":335023378353 },
            "jitter":{"avg":318.44610438849, "count":6920916, "max":2147483647, "min":0, "sum":2203938739},
            "latency":{"avg":60.928584742251, "count":6920916, "max":16383, "min":0, "sum":421681617},
            "mos":{"avg":2.686694992065, "count":6920916, "max":4.5, "min":0, "sum":18594390.357703},
            "cumalitveConcealRatio":{"avg":0.00081466591994468, "count":6920916, "max":0.9995, "min":0, "sum":5638.2343999998}, 
            "intervalConcealRatio":{"avg":0.0015669875201491, "count":6920916, "max":1, "min":0, "sum":10844.989},
            "intervalConcealRatioMax":{"avg":0.011221271880773, "count":6920916, "max":1, "min":0, "sum":77661.480099994},
            "concealSeconds":{"avg":3.616535874731, "count":6920916, "max":37719, "min":0, "sum":25029741},
            "severelyConcealSeconds":{"avg":1.594539219953, "count":6920916, "max":37094, "min":0, "sum":11035672},
            "numberVideoPacketsSent":{"avg":0,"count":6920916,"max":17324840,"min":0,"sum":0},
            "numberVideoOctetsSent":{"avg":0,"count":6920916,"max":1970765368,"min":0,"sum":0},
            "numberVideoPacketsReceived" :{"avg":0,"count":6920916,"max":7696079,"min":0,"sum":0},
            "numberVideoOctetsReceived":{"avg":0,"count":6920916,"max":3822641129,"min":0,"sum":0},
            "numberVideoPacketsLost":{"avg":0,"count":6920916,"max":4294967292,"min":0,"sum":0},
            "videoAverageJitter":{"avg":0,"count":6920916,"max":139,"min":0,"sum":0},
            "videoRoundTripTime":{"avg":0,"count":6920916,"max":1608,"min":0,"sum":0},
            "videoOneWayDelay":{"avg":0,"count":6920916,"max":0,"min":0,"sum":0},
            "cmr_duration":{"avg":0.042237617101551,"count":6920916,"max":43199,"min":0,"sum":292323},
            "videoDuration_channel2":{"avg":0,"count":6920916,"max":0,"min":0,"sum":0},
            "numberVideoPacketsSent_channel2":{"avg":0,"count":6920916,"max":0,"min":0,"sum":0},
            "numberVideoOctetsSent_channel2":{"avg":0,"count":6920916,"max":0,"min":0,"sum":0},
            "numberVideoPacketsReceived_channel2" :{"avg":0,"count":6920916,"max":0,"min":0,"sum":0},
            "numberVideoOctetsReceived_channel2":{"avg":0,"count":6920916,"max":0,"min":0,"sum":0},
            "numberVideoPacketsLost_channel2":{"avg":0,"count":6920916,"max":0,"min":0,"sum":0},
            "videoAverageJitter_channel2":{"avg":0,"count":6920916,"max":0,"min":0,"sum":0},
            "videoRoundTripTime_channel2":{"avg":0,"count":6920916,"max":0,"min":0,"sum":0},
            "videoOneWayDelay_channel2":{"avg":0,"count":6920916,"max":0,"min":0,"sum":0}},

  ::

       "termination_stats":{"17":{"count":190713,"description":"User busy","duration":2581},
            "-1593835503":{"count":9,"description":"Invalid termination code(-1593835503)","duration":0},
            "1174405137":{"count":3889,"description":"CCM_SIP_486_BUSY_HERE (Cisco  specific)","duration":0},
            "111":{"count":2109,"description":"Protocol  error","duration":271454},
            "47":{"count":55696,"description":"Resource  unavailable","duration":2424315},
            "458752":{"count":167,"description":"Drop any  party\/drop last party (Cisco specific)","duration":35490},
            "42":{"count":931,"description":"Switching equipment congestion","duration":1998},
            "127":{"count":828,"description":"Interworking","duration":2},
            "-1543503841":{"count":9,"description":"Invalid termination code(-1543503841)","duration":0},
            "82":{"count":135,"description":"Identified channel does not exist","duration":0},
            "393216":{"count":325690,"description":"Call split (Cisco specific)","duration":16263385},
            "63":{"count":14,"description":"Service or option not available","duration":150},
            "29":{"count":2,"description":"Facility rejected","duration":268},
            "27":{"count":18772,"description":"Destination out of order","duration":4401},
            "41":{"count":63192,"description":"Temporary failure","duration":4201087},
            "28":{"count":139,"description":"Invalid number format (address incomplete)","duration":378},
            "57":{"count":2,"description":"Bearer capability not  authorized","duration":282},
            "1":{"count":401406,"description":"Unallocated (unassigned)  number","duration":3855},
            "31":{"count":3652,"description":"Normal","duration":6},
            "50":{"count":83,"description":"Requested facility not subscribed","duration":0},
            "16":{"count":7746066,"description":"Normal call clearing","duration":2081913388},
            [...]
            },
       "elapsed_time":0.048560857772827
       }
        

   RESP_CODE: ``200``


