Get Segment

Returns segment information for the provided segment ID.

In addition to the list API, segment IDs can be extracted from within the Fullstory UI. When on the page for a segment, the URL will contain the segment's ID. For example, the URL https://app.fullstory.com/ui/ABCD/segments/12345abcdefg/people/0 corresponds to a segment with an ID of 12345abcdefg.

Path Parameters

id string required

The ID of the segment to be retrieved

Responses

200

---

A successful response.

Schema

Example

---

Schema

id string optional

Unique identifier for the segment.

name string optional

The display name of the segment.

creator string optional

The email associated with the Fullstory user who created the segment.

created date-time optional

UTC RFC 3339 timestamp for when the segment was created. Will not be present for built-in segments.

url string optional

URL for the corresponding segment in the Fullstory app.

{
  "id": "12345abcdefg",
  "name": "Power Users (Web)",
  "creator": "alice@example.com",
  "created": "2020-10-01T12:34:56.123Z",
  "url": "https://app.fullstory.com/ui/yourOrgId/segments/12345abcdefg"
}

Loading...