List traffic allocations

Beta

GET

https://api.vapi.ai/traffic-allocations

GET

/traffic-allocations

curl https://api.vapi.ai/traffic-allocations \
     -H "Authorization: Bearer <token>"

{
  "results": [
    {
      "id": "string",
      "orgId": "string",
      "allocationIntent": "follow-latest",
      "createdAt": "2024-01-15T09:30:00Z",
      "actorType": "user",
      "targets": [
        {
          "assistantVersion": "string",
          "position": 1.1,
          "percentage": 1.1
        }
      ],
      "assistantId": "string",
      "actorId": "string",
      "actorEmail": "string",
      "description": "string"
    }
  ],
  "metadata": {
    "itemsPerPage": 1.1,
    "totalItems": 1.1,
    "currentPage": 1.1,
    "totalPages": 1.1,
    "hasNextPage": true,
    "nextCursor": "string",
    "sortOrder": "ASC",
    "itemsBeyondRetention": true,
    "createdAtLe": "2024-01-15T09:30:00Z",
    "createdAtGe": "2024-01-15T09:30:00Z"
  }
}

The append-only history of an assistant’s allocations, newest first. Traffic splitting is in beta, rolling out to select organizations; requests from organizations without access receive a 403.

Authentication

AuthorizationBearer

Authenticate server-side requests with a private Vapi API key. Create or copy a key from the Vapi Dashboard and send it in the Authorization header as Bearer <token>. Keep private API keys out of client-side code and public repositories.

Query parameters

assistantIdstringOptional

Filter to allocations for this assistant.

pageintegerOptional>=1

The page number to return. Defaults to 1.

limitintegerOptional0-1000

The maximum number of items to return. Defaults to 100.

sortOrderenumOptional

The sort order for pagination. Defaults to 'DESC'.

Allowed values:

Response

resultslist of objects

metadataobject

Pagination and retention metadata returned with a paginated list of phone numbers.

Errors

403

Forbidden Error