WIwistia
Stats:Events

List Events

Retrieve a list of events. Please note that due to our data retention policy, only events from the last 2 years are available.

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/events

Request

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

Query parameters

media_idstring

An optional identifier for a specific video.

visitor_keystring

An optional identifier for a specific visitor.

per_pageinteger

Maximum number of events to retrieve (capped at 100).

pageinteger

The page of events to get data from.

start_datestring date

Start date in the format 'YYYY-MM-DD'.

end_datestring date

End date in the format 'YYYY-MM-DD'.

Headers

X-Wistia-API-Versionstring required

Response

Successful response with a list of events.

received_atstring date-time

Date and time when the event occurred.

event_keystring

Unique identifier for the event.

visitor_keystring

Identifier for the visitor.

embed_urlstring

URL of the page where the video was viewed.

percent_viewednumber float

Decimal number denoting how much of the video was watched.

ipstring

IP address of the viewer.

orgstring

Organization associated with the IP address.

countrystring

Country based on IP.

regionstring

Region based on IP.

citystring

City based on IP.

latnumber float

Latitude based on IP.

lonnumber float

Longitude based on IP.

emailstring nullable

Email of the viewer (if available).

media_idstring

Identifier for the video that was watched.

media_namestring

Name of the video.

media_urlstring

URL of the video in Wistia.

iframe_heatmap_urlstring

URL for the heatmap of the event.

attributesobject

Raw event attributes returned by the underlying analytics store. The keys mirror the top-level event fields.

Changes

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