Vinix· docs

Run report

Generate a queues or recipients report over a date range. Output is JSON by default; pass `format: csv` for CSV.

Sandbox is coming soon

Today, requests on this page run against your live account. A hosted sandbox with simulated PSTN is on the roadmap — until then, use a non-production user or callflow when experimenting.

Details
POST
/accounts/{account_id}/qubicle_reports

Generate a queues or recipients report over a date range. Output is JSON by default; pass format: csv for CSV.

Authorization

AuthToken
X-Auth-Token<token>

Obtain via PUT /v2/user_auth or PUT /v2/api_auth. See Authentication.

In: header

Path Parameters

account_id*string

Vinix account identifier.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/accounts/string/qubicle_reports" \  -H "Content-Type: application/json" \  -d '{    "data": {      "report": "queues",      "start_date": "2019-08-24T14:15:22Z",      "identifiers": [        "string"      ]    }  }'
{}
{
  "message": "string",
  "request_id": "string"
}