Stats:Visitors

List Visitors

This endpoint provides a list of visitors that have watched videos in your account.

Requires api token with one of the following permissions

Read detailed stats

Tokens with the "Act with a team member's permissions" permission (all:delegate_to_contact_permissions scope) can also be used. Requests made with such a token are authorized using the permissions of the contact assigned to the token.

An expiring access token created with the all:delegate_to_contact_permissions scope and an account authorization granting the view-stats permission can also be used.

get/stats/visitors

Request

  • Base URL
    https://api.wistia.com/modern
  • URL
    https://api.wistia.com/modern/stats/visitors
  • Auth
    HTTP bearer

Query parameters

pageinteger

The page of results based on the per_page parameter.

per_pageinteger

The maximum number of results to return, capped at 100.

filter'has_name' | 'has_email' | 'identified_by_email_gate'

Filtering parameter to narrow down the list of visitors.

searchstring

Search for visitors based on name or email address.

Headers

X-Wistia-API-Versionstring required

Response

Successful response with a list of visitors.

visitor_keystring

A unique identifier for the visitor.

created_atstring date-time

When the visitor was created.

last_active_atstring date-time

The last time the visitor played a video.

last_event_keystring nullable

The event key for the last video play action.

identifying_event_keystring nullable

The event key for the conversion event that identified the visitor. Null when the visitor has not been identified.

load_countinteger

The total number of videos loaded by the visitor.

play_countinteger

The total number of videos played by the visitor.

Changes

No recorded changes to this operation across all 1 revision of this API.