VoiceLayerDocs
Dashboard

Read public access usage today

GET
/v1/public-access/usage

Counts what happened on a website key today (UTC): sessions admitted and ended, and attempts turned away with the reason (a visitor sees one generic message, you see why). Read from the records the checks keep, so it is exact even after a restart. Pair it with the key's daily budget for spend.

Requires an API key with the public_access:read scope.

Authorization

apiKey
headerAuthorizationBearer <token>

A secret API key from the dashboard (Developers → API keys): vl_live_…, or vl_test_… for test mode. Each operation says which scope the key needs.

Query Parameters

keyId*string

The publishable website key to report on.

Length1 <= length <= 200

Response Body

Today's admitted sessions and refusals on the key

application/json
  1. response
keyId*string
since*string
Formatdate-time
admitted*integer
ended*integer
refusals*array<>
recent*array<>
Example Request
curl "https://api.vlayers.ai/v1/public-access/usage?keyId=$WEBSITE_KEY_ID" \  -H "Authorization: Bearer $VOICELAYER_API_KEY"
Example Response
{  "keyId": "key_9b3d42",  "since": "2026-10-20T00:00:00.000Z",  "admitted": 12,  "ended": 11,  "refusals": [    {      "reason": "challenge_failed",      "count": 3    },    {      "reason": "ip_rate",      "count": 1    }  ],  "recent": [    {      "admittedAt": "2026-10-20T15:04:05.000Z",      "endedAt": "2026-10-20T15:04:05.000Z",      "endReason": "room_finished"    }  ]}