LiveDiscoveryResult live.discovery-result@1

Generated at 2026-09-26 00:45:03 UTC from openvibe-contracts v0.53.0 and openvibe-sdk v0.11.0.

Version

1.0.0

Owner

live

Visibility

first-party

Status

active

Compatibility

backward

Schema

https://openvibe.network/contracts/live/discovery-result.v1.json

live.discovery-result@1: answers of live.discovery.read on OpenVibe.Live (public home and discovery reads; the same answer for everyone except /discover and /digest, which personalise for a signed-in viewer). GET /api/home/featured → { stream, moment, count, index, next_in_ms } ({ stream: null, count: 0 } when nobody is live); /api/home/stats-live → { liveNow, viewersNow, weeklyActive, users, …, concurrency, recent }; /api/home/hero → { stats, media, moments, slogans }; /api/home/star → { star } (null when there is none); /api/home/digest → { since, signed_in, liveNow, streamed, stats, hot }; /api/home/discover → { channel, live, clips, recaps, star, similar }; /api/home/pulse → Live's activity pulse with moments and latestUpdate; /api/home/stats/series/:metric?days= → { metric, kind, days, points, peak, … } (404 { error, metrics } for an unknown metric, 503 when Media's series are unavailable); /api/streams/recently-online → { streamers, total, limit, offset, hasMore }; /api/streams/recent-vods → { vods, total, limit, offset, hasMore }; /api/content/feed and /api/content/moments → { feed, type, sort, window, items, next, sources, partial }.

Fields

This schema has no named fields.

Examples

From the contract's own test fixtures: valid ones validate, rejected ones must fail.

{
  "stream": null,
  "count": 0
}

{
  "feed": "content",
  "type": "all",
  "sort": "new",
  "window": "week",
  "items": [
    {
      "kind": "clip",
      "id": "med_01JAB2C3D4E5F6G7H8J9K0MNPQ",
      "href": "/clip/med_01JAB2C3D4E5F6G7H8J9K0MNPQ",
      "title": "1v3 clutch"
    }
  ],
  "next": null,
  "sources": {
    "media": "ok",
    "community": "ok"
  },
  "partial": false
}

{
  "metric": "chat_messages",
  "kind": "count",
  "days": 30,
  "points": [
    {
      "day": "2026-09-24",
      "value": 5210
    }
  ],
  "total": 5210,
  "peak": 5210
}

{
  "count": -1
}

Validate

const contracts = require('openvibe-contracts');
contracts.validate('live.discovery-result@1', value);   // { valid, errors: [{ path, message }] }