analytics
event
get/analytics/{connection_id}/event

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/analytics/{connection_id}/event
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

property_idstring

The analytics property ID to filter by

session_idstring

The analytics session ID to filter by

visitor_idstring

The analytics visitor ID to filter by

typestring
start_gtestring

The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_ltstring

The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring
event_type'PAGE_VIEW' | 'SCREEN_VIEW' | 'CLICK' | 'FORM_SUBMIT' | 'PURCHASE' | 'SIGN_UP' | 'LOGIN' | 'LOGOUT' | 'SEARCH' | 'VIDEO_PLAY' | 'VIDEO_COMPLETE' | 'FILE_DOWNLOAD' | 'SCROLL' | 'SESSION_START' | 'FIRST_VISIT' | 'CUSTOM'
visitor_idstring

points to AnalyticsVisitor

property_idstring

points to AnalyticsProperty

session_idstring

points to AnalyticsSession

page_urlstring
page_titlestring
page_referrerstring
devicestring
browserstring
osstring
countrystring
country_codestring
regionstring
citystring
metadataPropertyAnalyticsEventMetadata
valuenumber
currencystring
utm_sourcestring
utm_mediumstring
utm_campaignstring
utm_termstring
utm_contentstring
rawobject

Changes