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/alice@example.com:12444435241/people/0 corresponds to a segment with an ID of alice@example.com:12444435241.

Method: GET

URI: /segments/v1/{id}

Parameters

NameTypeDescription
idstringThe ID of the segment to be retrieved

Request Headers

Authorization: Basic {YOUR_API_KEY}

Status Codes

200: A successful response.

Response Fields

NameTypeDescription
idstringUnique identifier for the segment.
namestringThe display name of the segment.
creatorstringThe email associated with the FullStory user who created the segment.
createdtimestampUTC RFC 3339 timestamp for when the segment was creted. Will not be present for built-in segments.
urlstringURL for the corresponding segment in the FullStory app.

Endpoint

GET https://api.fullstory.com/segments/v1/{id}

Example Request

curl -X GET \
  https://api.fullstory.com/segments/v1/alice@example.com:124251314 \
  -H 'content-type: application/json' \
  -H 'Authorization: Basic {YOUR_API_KEY}'

Example Response

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