Skip to content

Returns the most recent membership events for a segment

Description

Returns the most recent membership events for a segment. Each event represents a profile that entered or exited the segment.

This operation is paginated.

Usage

customerprofiles_list_segment_subscription_events(DomainName,
  SegmentDefinitionName, MaxResults, NextToken)

Arguments

  • DomainName

[required] The unique name of the domain.

  • SegmentDefinitionName

[required] The unique name of the segment definition.

  • MaxResults

The maximum number of events to return per page.

  • NextToken

The pagination token from the previous call to retrieve the next page of results.

Value

A list with the following syntax:

list(
  Events = list(
    list(
      ProfileId = "string",
      UpdatedAt = as.POSIXct(
        "2015-01-01"
      ),
      EventType = "LIVE"|"SCHEDULE",
      Event = "JOINED"|"LEFT"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_segment_subscription_events(
  DomainName = "string",
  SegmentDefinitionName = "string",
  MaxResults = 123,
  NextToken = "string"
)