1. Home
  2. Docs
  3. Private: Rali APIs
  4. Events API

Events API

Export events data

Endpoint Methods
https://api.onq.io/api/external/events GET


Event Request

URL Param Description
size Maximum number of assets to return in the call. Valid values are 1 through 1000. Required. Integer.
page Start position in query. Valid values are 1 (the first found asset) or higher integers. With each successive call for your search, increment this by the [page] value to get the next page of assets.

For example, by default your first call uses a 1 offset and limit of 32 to return the first 32 found assets. Call this API again with an offset of 32 to retrieve the next page. Required. Integer.

start Events start time.  Format “YYYY-MM-DD hh:mm”. Required. String.
end Events end time.  Format “YYYY-MM-DD hh:mm”. Required. String.
csv Export format is comma delimited if csv is set to true.  If false or not set, export format is JSON.  Optional. Boolean.


Event Response

Field Description
timestamp Event timestamp
source Event source: onq-web, onq-player, onq-mobile
type Event types: See Event Types section
user_id User identifier
email User email
user_session User session identifier
url Event url
org_id Organization identifier
content_id Content Identifier
tracker_id Conversation Identifier
video_time Event relative time in video
video_duration Video duration
in_focus Whether video was in focus during event
target_id If the event is a click event, identifier of the target of the click.
ip_address IP Address of the user
city City of the user
province Province of the user
country Country of the user
longitude Longitude of the user
latitude Latitude of the user
browser_family Browser of the user
device_family Device of the user
os_family OS of the user


Was this article helpful to you? Yes No

How can we help?