Class RetrieveParticipantStateApi

Constructors

constructor

Methods

getParticipationsBreakdownByContactId getParticipationsBreakdownByContactIdWithHttpInfo getParticipationsBreakdownByExternalEventId getParticipationsBreakdownByExternalEventIdWithHttpInfo getParticipationsBreakdownByMarketingEventId getParticipationsBreakdownByMarketingEventIdWithHttpInfo getParticipationsCountersByEventExternalId getParticipationsCountersByEventExternalIdWithHttpInfo getParticipationsCountersByMarketingEventId getParticipationsCountersByMarketingEventIdWithHttpInfo

Constructors

constructor

Methods

getParticipationsBreakdownByContactId

getParticipationsBreakdownByContactIdWithHttpInfo

getParticipationsBreakdownByExternalEventId

  • getParticipationsBreakdownByExternalEventId(externalAccountId, externalEventId, contactIdentifier?, state?, limit?, after?, _options?): Promise<CollectionResponseWithTotalParticipationBreakdownForwardPaging>

  • Read Marketing event's participations breakdown with optional filters by externalAccountId and externalEventId pair. Read participations breakdown by Marketing Event external identifier

    Parameters

    • externalAccountId: string

      The accountId that is associated with this marketing event in the external event application.

    • externalEventId: string

      The id of the marketing event in the external event application.

    • OptionalcontactIdentifier: string

      The identifier of the Contact. It may be email or internal id.

    • Optionalstate: string

      The participation state value. It may be REGISTERED, CANCELLED, ATTENDED, NO_SHOW

    • Optionallimit: number

      The limit for response size. The default value is 10, the max number is 100

    • Optionalafter: string

      The cursor indicating the position of the last retrieved item.

    • Optional_options: PromiseConfigurationOptions

    Returns Promise<CollectionResponseWithTotalParticipationBreakdownForwardPaging>

getParticipationsBreakdownByExternalEventIdWithHttpInfo

  • getParticipationsBreakdownByExternalEventIdWithHttpInfo(externalAccountId, externalEventId, contactIdentifier?, state?, limit?, after?, _options?): Promise<HttpInfo<CollectionResponseWithTotalParticipationBreakdownForwardPaging>>

  • Read Marketing event's participations breakdown with optional filters by externalAccountId and externalEventId pair. Read participations breakdown by Marketing Event external identifier

    Parameters

    • externalAccountId: string

      The accountId that is associated with this marketing event in the external event application.

    • externalEventId: string

      The id of the marketing event in the external event application.

    • OptionalcontactIdentifier: string

      The identifier of the Contact. It may be email or internal id.

    • Optionalstate: string

      The participation state value. It may be REGISTERED, CANCELLED, ATTENDED, NO_SHOW

    • Optionallimit: number

      The limit for response size. The default value is 10, the max number is 100

    • Optionalafter: string

      The cursor indicating the position of the last retrieved item.

    • Optional_options: PromiseConfigurationOptions

    Returns Promise<HttpInfo<CollectionResponseWithTotalParticipationBreakdownForwardPaging>>

getParticipationsBreakdownByMarketingEventId

  • getParticipationsBreakdownByMarketingEventId(marketingEventId, contactIdentifier?, state?, limit?, after?, _options?): Promise<CollectionResponseWithTotalParticipationBreakdownForwardPaging>

  • Read Marketing event's participations breakdown with optional filters by internal identifier marketingEventId. Read participations breakdown by Marketing Event internal identifier

    Parameters

    • marketingEventId: number

      The internal id of the marketing event in HubSpot.

    • OptionalcontactIdentifier: string

      The identifier of the Contact. It may be email or internal id.

    • Optionalstate: string

      The participation state value. It may be REGISTERED, CANCELLED, ATTENDED, NO_SHOW

    • Optionallimit: number

      The limit for response size. The default value is 10, the max number is 100

    • Optionalafter: string

      The cursor indicating the position of the last retrieved item.

    • Optional_options: PromiseConfigurationOptions

    Returns Promise<CollectionResponseWithTotalParticipationBreakdownForwardPaging>

getParticipationsBreakdownByMarketingEventIdWithHttpInfo

getParticipationsCountersByEventExternalId

  • getParticipationsCountersByEventExternalId(externalAccountId, externalEventId, _options?): Promise<AttendanceCounters>

  • Read Marketing event's participations counters by externalAccountId and externalEventId pair. Read participations counters by Marketing Event external identifier

    Parameters

    • externalAccountId: string

      The accountId that is associated with this marketing event in the external event application.

    • externalEventId: string

      The id of the marketing event in the external event application.

    • Optional_options: PromiseConfigurationOptions

    Returns Promise<AttendanceCounters>

getParticipationsCountersByEventExternalIdWithHttpInfo

  • getParticipationsCountersByEventExternalIdWithHttpInfo(externalAccountId, externalEventId, _options?): Promise<HttpInfo<AttendanceCounters>>

  • Read Marketing event's participations counters by externalAccountId and externalEventId pair. Read participations counters by Marketing Event external identifier

    Parameters

    • externalAccountId: string

      The accountId that is associated with this marketing event in the external event application.

    • externalEventId: string

      The id of the marketing event in the external event application.

    • Optional_options: PromiseConfigurationOptions

    Returns Promise<HttpInfo<AttendanceCounters>>

getParticipationsCountersByMarketingEventId

getParticipationsCountersByMarketingEventIdWithHttpInfo

Settings

Member Visibility

On This Page

Constructors
Methods