LiveAnalyticsReadResult live.analytics-read-result@1

Generated at from openvibe-contracts v0.79.0 and openvibe-sdk v0.25.0.

Version
1.0.0
Owner
live
Visibility
first-party
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/live/analytics-read-result.v1.json

live.analytics-read-result@1: the answer of GET /internal/analytics-summary?days=1-90 on OpenVibe.Live (capability live.analytics.read): { ok: true, summary } — Live's aggregate traffic totals only, for Network's navigation ordering (which sites are really used), never rows or people. summary is open (it grows with what Live measures). A failure is { ok: false, error }; a caller without the internal key gets 401 { ok: false }.

Fields

This schema has no named fields.

Examples

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

Valid: error
{
  "ok": false,
  "error": "analytics store unavailable"
}
Valid: summary
{
  "ok": true,
  "summary": {
    "pageviews": 125000,
    "sessions": 40211,
    "bots": 8300
  }
}
Rejected: no-summary
{
  "ok": true
}

Validate

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