Evidence composition by month

get/v1/stats/evidence-composition

How plays were evidenced by Vojo's two sources, month by month: corroborated (Passport and Harvester), Passport only, Harvester only, or neither. Aggregated server-side over every play in range, never sampled. Months are UTC calendar months of the play's start; months with no plays are returned as zeros.

Access

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

Query parameters

  • monthsinteger

    How many months back, including the current month.

    1 to 24

    Default 12

  • screen_idstring
  • advertisement_idstring

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

OK

  • dataarray of objectsRequired
    Show 5 fields
    • monthstringRequired

      UTC month of the play's start (YYYY-MM).

      matches ^[0-9]{4}-[0-9]{2}$

    • corroboratedintegerRequired

      Both Passport and Harvester saw the play — two independent observations.

      at least 0

    • passport_onlyintegerRequired

      Only Passport saw the play.

      at least 0

    • harvester_onlyintegerRequired

      Only Harvester saw the play.

      at least 0

    • unprovenintegerRequired

      Neither Vojo source saw the play.

      at least 0

  • metaobjectRequired

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).

  • 404

    The resource does not exist, or belongs to another organisation. Cross-org ids always 404, never 403.

  • 429

    Rate limit exceeded for this principal. Back off for Retry-After seconds.

  • 500

    Unexpected server failure.