List a play's evidence events

get/v1/plays/{play_id}/events

The verification events matched into this play: Passport lifecycle events and harvester fingerprint reads. Oldest first. Partner echo fields are returned verbatim and are never scored.

Access

Authentication
Secret key or OAuth access token.
Scope
plays:read
User permission
advertisementViewStats

Path parameters

  • play_idstringRequired

Query parameters

  • cursorstring

    Opaque cursor from a previous response's meta.next_cursor. Omit for the first page.

  • limitinteger

    Page size, 1-100. Default 25. A value outside 1-100, or not an integer, is rejected with 400 invalid_request (it is not clamped).

    1 to 100

    Default 25

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 11 fields
    • idstringRequired
    • sourcestringRequired

      passport = the in-creative fingerprint (wrapper) events; harvester = sensor reads on the glass.

      One of passport, harvester

    • event_typestring or nullRequired

      Passport lifecycle step; null for harvester events.

      One of content_started, fingerprint_sequence_finished, content_finished

    • occurred_atstringRequired

      date-time

    • screen_idstring or nullRequired
    • advertisement_idstring or nullRequired
    • wrapper_idstring or nullRequired
    • harvester_idstring or nullRequired
    • fingerprintstring or nullRequired

      Fingerprint code observed or emitted, when the event carried one.

    • duration_secondsnumber or nullRequired
    • match_statusstringRequired

      One of pending, matched, unmatched, conflict

  • metaobjectRequired

    Pagination metadata for cursor-paginated lists.

    Show 2 fields
    • next_cursorstring or nullRequired

      Opaque cursor for the next page. Pass it back as cursor. null when there are no more results.

    • has_morebooleanRequired

      True when another page exists (equivalent to next_cursor != null).

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.

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