Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListSegmentSubscriptionEvents

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

This operation is paginated.

Request Syntax


GET /domains/DomainName/segment-definitions/SegmentDefinitionName/subscription-events?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

DomainName

The unique name of the domain.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

MaxResults

The maximum number of events to return per page.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken

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

Length Constraints: Minimum length of 1. Maximum length of 1024.

SegmentDefinitionName

The unique name of the segment definition.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Events": [ 
      { 
         "Event": "string",
         "EventType": "string",
         "ProfileId": "string",
         "UpdatedAt": number
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Events

A list of segment membership events.

Type: Array of SubscriptionEventItem objects

NextToken

The pagination token to use to retrieve the next page of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

InternalServerException

An internal service error occurred.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource does not exist, or access was denied.

HTTP Status Code: 404

ThrottlingException

You exceeded the maximum number of requests.

HTTP Status Code: 429