Client Level Analytics

Attendees by Email Multiple Events

Returns a listing of all attendance information for a specific email address. There is a limit of 100 registrants 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", the 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
get/client/{clientId}/attendee/{email}/allevents

Request

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

Path parameters

clientIdstring required

The client id

emailstring required

The email to lookup

Query parameters

pageoffsetinteger

Selects the page to retrieve

excludesubaccountsstring

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

subaccountsstring

Comma separated list of child client ids

itemsperpageinteger

Number of items to be retrieved per page

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

Changes

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