Client Level Analytics

Attendees

Returns a listing of attendees for a particular client. There is a limit of 100 attendees per page.

  • 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 excludeSubaccounts is "Y", following error message is returned: "You have to set excludesubaccounts='N' 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 parameter conditions (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
  • realtimeonly parameter conditions (when "Y" is passed):
    • Properties that rely on the datawarehouse will not be included in the response, including:
      • engagementscore
      • firstliveactivity
      • lastliveactivity
      • firstarchiveactivity
      • lastarchiveactivity
      • askedquestions
      • resourcesdownloaded
      • answeredpolls
      • answeredsurveys
      • cumulativeliveminutes
      • cumulativearchiveminutes
      • Any activity / updates that have occurred in the last 15 minutes will be available in the response.
get/client/{clientId}/attendee

Request

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

Path parameters

clientIdstring required

The client 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 date

Limit results to those with attendee activity after startDate

enddatestring date

Limit results to those with attendee activity before endDate

pageoffsetinteger

Selects the page to retrieve

excludesubaccountsstring

if set to "Y", sub-accounts will be excluded

subaccountsstring

Comma separated list of child client ids

partnerrefstring

filter by partnerref

excludelivestring

filter to exclude live attendees

filterforgottenstring

Deprecated - Forgotten users filter. Y: only forgotten users will be returned. N: forgotten users will be omitted.

itemsperpageinteger

Number of items to be retrieved per page

userstatusstring

Filters users based on their status. Possible values: any, deleted, forgotten.

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.

realtimeonlystring

Filter to exclude properties that rely on the datawarehouse.

Headers

accessTokenKeystring required

client access token key

accessTokenSecretstring required

client access token secret

Response

Return list of attendees

  • 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:
    • firstliveactivity
    • lastliveactivity
    • liveviewed
    • archiveviewed
    • firstarchiveactivity
    • lastarchiveactivity
    • answeredpolls
    • engagementscore
  • Additionally, there may be a delay of up to 24 hours before new Attendees show up in this endpoint response.

Changes

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