analytics
visitor

List all visitors

Changed on
get/analytics/{connection_id}/visitor

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/analytics/{connection_id}/visitor
  • 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

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)

property_idstring

points to AnalyticsProperty

emailstring
namestring
first_namestring
last_namestring
agenumber
gender'MALE' | 'FEMALE' | 'INTERSEX' | 'TRANS' | 'NON_BINARY'
countrystring
country_codestring
citystring
languagestring
timezonestring
first_seen_atstring date-time

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

last_seen_atstring date-time

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

total_sessionsnumber
total_page_viewsnumber
total_eventsnumber
metadataPropertyAnalyticsVisitorMetadata
rawobject

Changes

  • 88a1fc7820d6Revision changes
    • info

      added the enum value first_name to the property items/ of the query request parameter fields

    • info

      added the enum value last_name to the property items/ of the query request parameter fields

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • a29ffd62ac71Revision changes
    • breaking

      the response's body type changed from no type to array for status