Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • UserName - Optional. The user associated with the event. If not passed, the method will use the current user credentials.
  • SessionID - Required. The A unique browser session ID associated with the event.
  • Event Type - Required. The event type ID number
  • URL - Required. The URL of the page where the event occurred.
  • UserAgent - Optional. The user details including browser type and OS version.
  • ClientIP - Optional. The user IP address.
  • Param1 - Optional. Used to store additional information about the event, typically for custom event types. This string is limited to 1000 characters. Built-in events reserve this string for the system. For example, in a "Visit" event it stores the referrer information; in a "Search" event it stores the search term.
  • Param2 - Optional. Used to store additional information about the event, typically for custom event types. This string is limited to 50 characters. Built-in events reserve this string for the system. For example, in a "Search" event it is used to store the number of results.

...

In addition to event objects, the request body may must include the following properties:

  • browserType - The user-agent information
  • sessionid - The unique session ID associated with the events. Any string format accepted.
  • un - User name. Any string format accepted.

...