Versioning (Insights Stats API)

Owned by Helen Griffith
Last updated: Oct 12, 2023
1 min read

Version headers are mandatory for all Stats API requests.

Specify the version of the API in the accept header parameter using the RFC 2616 protocol.

For example, to use version 3 of the API, set the accept header parameter to application/vnd.newvoicemedia.v3+json:

Accept: application/vnd.newvoicemedia.v3+json

If you do not include a version, you will receive the following error:

HTTP/1.1 400
Content-Length: 35
{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Invalid Accept header!"
}

If you specify an invalid version, you will receive the following error:

HTTP/1.1 400
Content-Length: 89
{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Invalid api-version! Valid values: 2,3"
}