Admin VR Stats

Get virtual receptionist statistics with optional time distribution

POST /v2/admin/reporting/virtual-receptionist/stats

Admin VR Stats

cURL

curl --request POST \
  --url https://api.voxo.co/v2/admin/reporting/virtual-receptionist/stats \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "vrId": 1,
  "startDate": "<string>",
  "endDate": "<string>"
}
'

200

{
  "results": [
    {
      "option": "<string>",
      "total": 123,
      "distribution": "<string>"
    }
  ],
  "vrId": 123,
  "date": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

vrId · number · required

Virtual receptionist ID

Required range: x > 0

startDate · string · required

Start date for the report period

endDate · string · required

End date for the report period

distribution · Option 1 · enum<string> Option 2 · enum<string> Option 3 · enum<string> Option 4 · enum<string>

Time distribution grouping (daily, weekly, monthly, or totals)

Available options: weekly

tag · string[]

Filter by call tags

Minimum array length: 1

callOutcome · number[]

Filter by call outcome IDs

Minimum array length: 1

dialed · string[]

Filter by dialed numbers

Response

200

application/json

VR statistics or export acknowledgement

Option 1 · object

Option 2 · object[]

Option 3 · object

Virtual receptionist statistics

results · object[] · required

Virtual receptionist statistics

Show child attributes

vrId · number

Virtual receptionist ID

date · string

Distribution date