Client Level Analytics

Registrants

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

  • If double opt-in verification was enabled at the time of registration for an event, and a user has not completed the verification process, the user will not be included in any endpoint responses.
  • 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=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 the data of the child client IDs included in the parameter.
  • 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 registrants who have had activity between (and including) the provided startDate and endDate. Registrant lastActivity value is updated with new modified date whenever one of the following API endpoints gets invoked to modify the registration information:
      • REST Registration
      • Update Registrant (client-level)
      • Forget Registrant (client-level)
      • Forget All Registrant (client-level)
      • Forget All Registrant (event-level)
get/client/{clientId}/registrant

Request

  • Base URL: https://api.on24.com/wcc/api/v2
  • URL: https://api.on24.com/wcc/api/v2/client/{clientId}/registrant
  • 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.

excludeSubaccountsstring

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

pageoffsetinteger

Selects the page to retrieve

startdatestring date

Limit results to registrants with registration date after startDate

enddatestring date

Limit results to registrants with registration date 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. all: deprecated - will include regular and soft-deleted users. Note: By design, there is No option to exclude soft-deleted users from the response.

excludelivestring

Filter to exclude registrants which register after event ends

filterforgottenstring

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

itemsperpageinteger

Number of items to be retrieved per page

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.

subaccountsstring

Comma separated list of child client ids

datefiltermodestring

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

Headers

accessTokenKeystring required

client access token key

accessTokenSecretstring required

client access token secret

Response

Return list of registrants

  • This endpoint returns data on people who registered for a Virtual Environment (VE).
  • Properties that will not be returned for VE registrants include:
    • userprofileurl
    • engagementprediction
    • emailformat
  • The following values are cached on the server between 3 - 24 hours:
    • engagementprediction

Changes

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