Start device data stream

get

https://{nurevaDeviceIP}/api/v1/data

Allows clients to start a device data stream from the following events:

soundLocation
deviceMetrics
voiceAmplificationRmsLevel
hdxVoiceAmplificationLevelChannel1
hdxVoiceAmplificationLevelChannel2
hdxVoiceAmplificationLevelChannel3
hdxVoiceAmplificationLevelChannel4
hdxSignalLevelChannel1
hdxSignalLevelChannel2
hdxSignalLevelChannel3
hdxSignalLevelChannel4

The stream can be filtered based on event type using the events query parameter.
Minimum role required: general

Example Sound Location Data Body

{
  "azimuth": -34,
  "powerLevel": 76,
  "time": "2024-11-01T18:08:24.834Z",
  "coordinates": {
    "x": -2688,
    "y": 3932
  },
  "triggeredZones": [
    {
      "type": "Switching",
      "label": "Zone 1",
      "id": "40dc92d0-1b49-44c8-ada8-3a0f97b7b185"
    }
  ],
  "version": 3,
  "flags": {
    "powerZeroedReason": 0,
    "speakerActive": false,
    "voiceAmpModeActive": false,
    "voiceDetected": true
  }
}

Example Device Metrics Data Body

{
  "backgroundNoise": 20
}

Example Voice Amplification Level Data Body

Example Signal Level Data Body

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

events

array of strings

A comma-separated list of event types to filter the stream. If this parameter is not provided, the stream will include the soundLocation and deviceMetrics events by default for supported devices. To receive the data stream for the remaining events, the event types must be specified in this parameter as it is not included in the default stream.

events

Headers

Nureva-Client-Id

string

required

Identifier for the integration application or service. This is intended for you to specify the name of your integration. Use this same value every time your integration calls into the Nureva device. There is no strict format as long as the value is limited to 500 characters. For example, "MyCompany Integration", "Power API", "SyncMaster", "Cloud Orchestrator", "Ultimate Audio Overlord" are all acceptable values.

Nureva-Client-Version

string

required

Identifier for the integration version. This is intended for you to specify the version of your integration application or service. There is no strict format as long as the value is limited to 500 characters. For example, "1", "2.0", "1.5.2", "beta", "1.0.0-alpha", "1.0.0+20250102" are all acceptable values.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Success

400Bad Request. Either one of the required headers are missing

401Unauthorized. Invalid or missing credentials

429Too many requests. Rate limit is exceeded

500Internal Server Error. Unexpected error has occurred.