Endpoint reference

GET

api/v1/data/zones/<zone_id>/trending

This endpoint returns data of how the zone is trending.

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/<zone_id>/trending

cURL

curl -X GET https://api3.waved.co/api/v1/data/zones/<zone_id>/trending \ 
-H 'Content-Type: application/json' \ 
-H 'Authorization: Bearer YOUR-TOKEN' \ 
-d '{ }'

About the endpoint

This endpoint returns data of how the zone is trending.

The data shows the movement of the mood index and loudness index over the last 6 hours.

The data is updated every 15 minutes and is useful for understanding the trend of the zone, and to act on the crowd behavior.

It also includes a summary of the trend, which is a distilled version of the trend, indicating if it’s trending up, down or stable.

Return Object

{
  "zone_id": "<string>",
  "zone_name": "<string>",
  "timestamp": "<string>",
  "trending": {
    "mood": {
      "index": "<number[]>",
      "tag": "<string[]>"
    },
    "loudness": {
      "index": "<number[]>",
      "tag": "<string[]>"
    },
    "time": {
      "utc0": "<string[]>"
    }
  },
  "summary": {
    "mood": {
      "index": "-1 | 0 | 1",
      "tag": "<string>",
      "speed_tag": "<string>",
      "rate_per_hour": "<number>",
      "synopsis": "<string>"
    },
    "loudness": {
      "index": "-1 | 0 | 1",
      "tag": "<string>",
      "speed_tag": "<string>",
      "rate_per_hour": "<number>",
      "synopsis": "<string>"
    }
  }
}