Get statistics for a scenario

This resource is used to get back verification statistics for a specific scenario for a defined time range.

URL: baseURL/scenario/{id}/stats

Method: GET

Headers:

Content-Type: application/json
principalId:{accountID}

Example Request:

curl --location --request GET 'http://baseURL/scenario/{id}/stats' \
--header 'Content-Type: application/json' \
--header 'principalId: 1' \
--data '{
    "date_from": "2020-08-04T00:10:32Z",
    "date_to": "2020-10-04T00:10:32Z"
}'

Response Body:

{
  "verifications": {
    "summary": {
      "total": 4,
      "IN PROGRESS": 1,
      "FAILED": 1,
      "COMPLETED": 2
    },
    "sms": {
      "total": 4,
      "SENDING": 1,
      "FAILED": 3
    },
    "viber": {
      "total": 4,
      "NOT ACTIVATED": 1,
      "FAILED": 1,
      "SENT": 2
    },
    "voice": {
      "total": 4,
      "NOT ACTIVATED": 3,
      "FAILED": 1
    }
  },
  "sticky_count": 2,
  "date": "2020-10-08T07:08:16Z"
}