Component Specific Metrics Endpoints: Metrics & Filters

Metrics & Filters of Metrics API

All metrics endpoints have the following request payload:

JSON

{
    "metrics": [
        "metric1","metric2",...
    ],
    "filters": {
        "filter1": ["value1_1", "value1_2",...],   // List<String>, List<Boolean>
        "filter2": “value2”,                             //String
        "filter2": true/false,                            //Boolean
         ...
    },
    "start": "yyyy-MM-dd HH:mm:ss",
    "end": "yyyy-MM-dd HH:mm:ss",
    "group": "group_value",
    "downsampling": "downsampling_value",  //'five_min','hour', 'day', 'week', 'month', 'year'
    "drilldown": false/true
}

Below are all the available metrics and filters for each metrics API endpoint:

endpoint	metrics	filters
realtime endpoints
/{version}/realtime/metrics/sessions	`sessions_initiated`	channel (List<String>), test_flag (Boolean), region (List<String>)
/{version}/realtime/metrics/miniapps	`miniapps_agent_requests` `miniapps_critical_error` `miniapps_invocations miniapps_invocations_successful` `miniapps_no_inputs` `miniapps_no_matches` `miniapps_system_errors` `miniapps_asr_connection_error`	channel (List<String>), test_flag (Boolean), region (List<String>), locale (List<String>), miniapp_type (List<String>), miniapp_name (List<String>)
/{version}/realtime/metrics/dialogs	`dialogs_completed, dialogs_transferred` `dialogs_terminated` `root_agent_requests` `root_critical_error` `root_no_inputs` `root_no_matches` `root_system_errors` `root_asr_connection_error`	channel (List<String>), test_flag (Boolean), region (List<String>), locale (List<String>), flow_name (List<String>)
batch metrics
/{version}/batch/metrics/vb/verification	`dialogs_count` `speechduration`	verification_origin (List<String>), region (List<String>), speech_duration_groups (List<String>), verification_result (List<String>)
/{version}/batch/metrics/vb/enrolment	`enrolment_requests`	origin (List<String>), region (List<String>), voice_print_fail_reason (List<String>), voice_print_fail (List<Boolean>)
/{version}/batch/metrics/sessions	`sessions` `invocations` `duration10sec`	channel (List<String>), region (List<String>)
/{version}/batch/metrics/miniapps	`totalinvocations` `successfultasks` `failedtasks` `errortasks` `hangeduptasks` `othertasks` `dtmfescapekeytasks`	channel (List<String>), language (List<String>), miniapp_name(List<String>), miniapp_id (List<String>), miniapp_type (List<String>), region (List<String>), miniapp_fail_reason (List<String>)
/{version}/batch/metrics/dialogs	`dialogs` `terminated` `transferred` `error` `other`	channel (List<String>), language (List<String>), miniapp_name (List<String>), miniapp_id (List<String>), miniapp_type (List<String>), region (List<String>)