Event Level Analytics

Attendees

Returns a list of attendees for a particular event. All dates and times are in Pacific Time.

  • dateFilterMode parameter options (not case-sensitive):
    • If the parameter is not included or no value is supplied, startDate and endDate will work in the manner they usually do.
    • "lastActivity" is the only supported value. When passed, the response will include only those attendees who have had activity between (and including) the provided startDate and endDate. Attendee lastActivity value is updated with new modified date whenever one of the following actions is performed by an attendee:
      • Starting new session
      • Refreshing browser during webcast presentation
      • Submitting poll answers
get/client/{clientId}/event/{eventId}/attendee

Request

  • Base URL: https://api.on24.com/wcc/api/v2
  • URL: https://api.on24.com/wcc/api/v2/client/{clientId}/event/{eventId}/attendee
  • Auth: one of:
    • API key in header AccessTokenKey
    • API key in header AccessTokenSecret

Path parameters

clientIdnumber required

The client id

eventIdnumber required

The event id

Query parameters

dateIntervalinteger

Number of days returned in a response. See Rolling Interval.

dateIntervalOffsetinteger

Number of days from which the interval should encompass. See Rolling Interval.

dateIntervalTimezonestring

Timezone to be used for determining the 24 hour period that constitutes a day. See Rolling Interval.

startdatestring

Limit results to those with attendee activity after startDate

enddatestring

Limit results to those with attendee activity before endDate

partnerrefstring

Filter by partnerref

userstatusstring

Filter to users based on their status. If not provided, only regular users will be returned. Possible values: any: will return all registrants, including: active, soft-deleted and forgotten registrants. deleted: will return soft-deleted users only. forgotten: will return forgotten users only. Note: By design, there is No option to exclude soft-deleted users from the response.

filterforgottenstring

Deprecated - Forgotten registrants filter. Y: only forgotten users will be returned in the response. N: forgotten users will be omitted in the response.

excludeanonymousstring

Deprecated - System-Generated (anonymous) email addresses are now always excluded from responses. This parameter is retained for backward compatibility but no longer affects the result set.

datefiltermodestring

Type of date to be used with the startDate and endDate parameters.

Headers

accessTokenKeystring required

Security Parameter

accessTokenSecretstring required

Security Parameter

Response

Return list of attendees for an event

  • Values for fields liveminutes, archiveminutes, cumulativeliveminutes and cumulativearchiveminutes are rounded to the closest integer value (e.g. 2.316 is returned as 2, 3.542 is returned as 4). If an attendee's actual viewing minutes are greater than 0 and less than 1, response will return 1 as the value (e.g. 0.123 is returned as 1).
  • The following values are cached on the server between 3 - 24 hours:
    • engagementscore

Changes

No recorded changes to this operation across all 1 revision of this API.