Get destinations for a segment
Learn more about the activation Api to get all destinations for a segment.
This Activation service API will enable you to retrieve and list all destinations along with schedule for activation of a segment.
Request
GET /api/[env]/[tenant]/destinations?segmentUri=[segmentUri]&max=[max]&offset=[offset] | Parameter | Required | Description | |
|---|---|---|---|
| Headers | Authorization
| Yes | Information about authentication access token in the format "Bearer <accessToken>". For more information, see Authentication API. |
Request parameter
| Parameter | Type | Description |
|---|---|---|
| segmentUri | String | The segment URI for which you want to retrieve destinations. |
| max | Number | The maximum number of results to be displayed in a page. |
| offset | Number | The offset for pagination. |
Response
| Parameter | Type | Description |
|---|---|---|
| success | boolean | True for success response |
| error | Error | Error object for details |
| total | Number | The total count of destinations for the specified segment. |
| result | Destination[] | Array of destination |
| result[number].id | String | UUID of the destination |
| result[number].integrationId | String | UUID of the integration |
| result[number].type | Type of schedule, which can be One time or recurring. | |
| result[number].schedule | String | If you selected the Recurring type, enter a string with a recurring rule based on RFC 5545. If you selected the One time type, enter a date. |
| result[number].segmentUri | String | The segment URI to get details about the segment. |