Verified plays by method

get/v1/stats/verification

This endpoint is in the contract, but the API doesn't serve it during early access. It returns 404 for now.

All-time and daily verified-play counts for one method. Org scope counts every verification row for the org (including Passport plays on non-Vojo screens); site / screen scopes only count rows with a screen.

curl "https://api.vojo-media.com/v1/stats/verification?type=wrapper" \
  -H "Authorization: Bearer $VOJO_KEY"

const { data, error } = await api.GET("/v1/stats/verification", {
  params: { query: { type: "wrapper" } },
});
if (error) throw new VojoApiError(error);

Response 200

{
  "data": {
    "type": "wrapper",
    "plays_all_time": 1289331,
    "series": [
      {
        "bucket_start": "2026-10-06T00:00:00Z",
        "plays": 8120
      },
      {
        "bucket_start": "2026-10-07T00:00:00Z",
        "plays": 3311
      }
    ]
  },
  "meta": {
    "scope": {
      "type": "org",
      "id": null,
      "name": null
    },
    "generated_at": "2026-10-07T09:30:00Z"
  }
}

Access

Authentication: Secret key or OAuth access token.
Scope: stats:read
User permission: networkViewStats

Query parameters

typestringRequired
Verification method.
One of wrapper, harvester
daysinteger
Days of daily series.
1 to 90
Default 30
scope_typestring
Slice of the fleet to aggregate over. Default org.
One of org, site, screen, campaign
Default "org"
scope_idstring
Entity id for scope_type site / screen / campaign (required for those, ignored for org). Resolved server-side within the org: an id from another org yields an empty result, never a leak.

Headers

Vojo-Organisationstring
The organisation this request acts on (org id). Required for oauth2 callers — a missing header returns 400 organisation_header_required; an org the user cannot access (a membership or an access grant, and granted to this OAuth client) returns 403 organisation_access_denied. Secret keys are bound to one org: the header may be omitted, and if sent it must match the key's org (else 403). Every query is scoped by the resolved org, never by an id in the body.
Vojo-Versionstring
Optional API version pin (a date). Overrides the version pinned on the secret key / organisation for this request. Echoed in the Vojo-Version response header. Within /v1 only additive changes ship, so most callers can omit it.
date

Response 200

dataobjectRequired
Verified-play counts for one verification method.
Show 3 fields
- typestringRequired
  One of wrapper, harvester
- plays_all_timeintegerRequired
  Total verified plays for this method.
  at least 0
- seriesarray of objectsRequired
  Daily counts, oldest first.
  Show 2 fields
  - bucket_startstringRequired
    RFC 3339 / ISO-8601 UTC timestamp.
    date-time
  - playsintegerRequired
    at least 0
metaobjectRequired
Metadata for aggregate reads.
Show 2 fields
- scopeobjectRequired
  The scope the aggregate was resolved to, echoed so callers need no extra lookup for a label.
  Show 3 fields
  - typestringRequired
    Slice of the fleet an aggregate is computed over.
    One of org, site, screen, campaign
  - idstring or nullRequired
    Entity id for site / screen / campaign scopes; null for org.
  - namestring or nullRequired
    Display name of the scoped entity; null for org.
- generated_atstringRequired
  When the aggregate was computed.
  date-time

Response headers

Vojo-Versionstring
The API version (date) this response was rendered with — the request's Vojo-Version, else the key/org pin.
RateLimitstring
IETF RateLimit header: remaining quota in the current window, e.g. "default";r=97;t=42.
RateLimit-Policystring
IETF RateLimit-Policy header, e.g. "default";q=100;w=60. Portal OAuth clients get a higher tier.

Errors

Every error is application/problem+json. Branch on its code.

400
Malformed request: invalid JSON, a bad cursor, a missing Vojo-Organisation for an OAuth caller, or an unknown Vojo-Version.
401
Missing, invalid, expired or revoked credential.
403
The caller is authenticated but not allowed: missing scope (insufficient_scope), missing Permissions flag (permission_denied), a client/installer persona on an operator endpoint (operator_access_required), or no access to the requested org (organisation_access_denied).
422
Well-formed request that failed validation. errors[] lists each failing field.
429
Rate limit exceeded for this principal. Back off for Retry-After seconds.
500
Unexpected server failure.