api/v1/data/zones/live

This endpoint returns live data for all zones in the venue.

Base URLhttps://api3.waved.co

AuthenticationBearer token

Contract review required

The full migrated endpoint description and response example are preserved below. They must be checked against the authoritative API contract before publication.

Migrated reference

The complete public source content is preserved below. Examples still require technical verification before launch.

GET :

api/v1/data/zones/live

cURL

curl -X GET https://api3.waved.co/api/v1/data/zones/live \

-H 'Content-Type: application/json' \

-H 'Authorization: Bearer YOUR-TOKEN' \

-d '{ }'

About the endpoint

This endpoint returns live data for all zones in the venue.

The data is updated every 5 minutes and is useful for understanding the current state of the venue.

It's up to the developer to use the data from the zones in a sensible way. This often requires some knowledge of the venue to know which zones are most useful.

If you want a distilled version of the data in some form, you can use the /zones/busiest endpoint, or use the /venue/live endpoint, and look at the "representative" data - more on this in the /venue/live endpoint documentation.

Return Object

[
  {
    "zone_id": "<string>",
    "zone_name": "<string>",
    "automation_is_on": "<boolean>",
    "timestamp": "<string>",
    "mood": {
      "index": "<number>",
      "tag": "<string>"
    },
    "loudness": {
      "index": "<number>",
      "tag": "<string>"
    },
    "vibe": {
      "level": "<number>",
      "tag": "<string>"
    },
    "music": {
      "level": "<number>",
      "automation": "<string>",
      "muted": "<boolean>",
      "source": {
        "source_id": "<string>",
        "source_name": "<string>"
      }
    },
    "error": "<string>"
  }
]