GET/Activities/{activityId}/segments
Returns an activity's run-of-show segments, with their column values, and the column configuration
that shapes the table. The id comes from Activities_GetActivities; needs an event token and event
basic access.
Path Parameters
| Field | Type | Required | Description |
|---|
| activityId | uuid | Required | |
Response
| Field | Type | Description |
|---|
| id | uuid | |
| name | string| null | |
| startDateTime | date-time | |
| endDateTime | date-time | |
| segments | GetActivitySegmentsResponseSegment[]| null | |
| configuration | GetActivitySegmentsResponseActivityConfiguration | |
GetActivitySegmentsResponseSegment
| Field | Type | Description |
|---|
| id | uuid | |
| name | string| null | |
| index | integer | |
| startDateTime | date-time | |
| duration | integer | |
| color | string| null | |
| properties | GetActivitySegmentsResponseSegmentProperty[]| null | |
GetActivitySegmentsResponseActivityConfiguration
| Field | Type | Description |
|---|
| segmentColumns | GetActivitySegmentsResponseActivityConfigurationSegmentColumn[]| null | |
GetActivitySegmentsResponseSegmentProperty
| Field | Type | Description |
|---|
| columnId | uuid | |
| value | string| null | |
GetActivitySegmentsResponseActivityConfigurationSegmentColumn
| Field | Type | Description |
|---|
| id | uuid | |
| index | integer | |
| name | string| null | |
| size | string| null | |