Events

Returns a listing of events for a particular client. Events belonging to sub-client accounts are not included in the response.

• If startDate and endDate are not sent, the response will return all events from the past 3 months.
• The startDate and endDate will filter the list of events based on dateFilterMode parameter value.
• If includesubaccounts is "Y", pagination will be required. Both pageOffset and itemsPerPage parameters will be available. Response schema differs.
• subaccounts parameter conditions:
  • Value can be 1 or more child client IDs (multiple values will need to be delimited by a comma).
  • Child client IDs must be under the {clientId} of the request.
  • If subaccounts is provided and includeSubaccounts=N (either explicitly or by default), the following error message is returned: "You have to set includesubaccounts='Y' in order to filter by subaccounts.".
  • If subaccounts includes multiple values and at least one value is not valid, an error message is returned.
  • When subaccounts is provided, the response will only return data for the child client IDs included in the parameter.
• dateFilterMode accepted values (not case-sensitive):
  • "goodafter" (default): date and time an event is first available for the audience.
  • "updated": filters based on "lastupdated" attribute in the response. It may be between 2 and 12 hours to see changes on "lastupdated". The "lastupdated" is the last time an event had audience activity as:
    • Event is created
    • New Registrant
    • New Attendee
    • Poll is answered
    • Survey is answered
  • "modified": filters based on "lastmodified" attribute in the response. "lastmodified" is the last time the event's information was modified.
  • "creation": date and time an event was created.
  • "livestart": date and time an event starts the live broadcasting.
  • "liveend": date and time an event ends the live broadcasting.
  • "archivestart": date and time an event will be available on-demand for the audience.
  • "archiveend": date and time an event won't be available anymore for the audience.
• filterOrder accepted values (not case-sensitive):
  • "asc" (default): ascending
  • "desc": descending
• contentType accepted values (not case-sensitive):
  • "all" (default)
  • "experience": Experience Hub contents
  • "gateway": Engagement Hub contents
  • "golive": Go Live events
  • "pdf": Documents from Media Manager library
  • "video": Videos from Media Manager library
  • "webcast": Elite webinars
  • "webpage": Links from Media Library
  • "forum": Forum events
• In the Client Level Events response, "eventlocation" is the same as the "campaigncode" (Campaign Code).