List Segments

Lists segments

Query Parameters

limit int32 optional

Optionally limit the number of segments returned. Defaults to 20. The max limit for a single page is 100.

paginationToken string optional

Optional pagination token for retrieving more results. List params should not change between consecutive paginated requests (limit is an exception).

creator string optional

If set, filters the returned segments by the provided creator. This should be an email associated with a FullStory account.

Responses

200

---

A successful response.

Schema

Example

---

Schema

segments object[] optional
Array [
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.
]
nextPaginationToken string optional

If present, then there are more results which can be retrieved by making another request with this token as the pagination_token.

{
  "segments": [
    {
      "id": "abcdefg12345",
      "name": "Visits to jobs page",
      "creator": "bob@example.com",
      "created": "2020-10-22T14:30:10.631Z",
      "url": "https://app.fullstory.com/ui/yourOrgId/segments/abcdefg12345"
    },
    {
      "id": "12345abcdefg",
      "name": "Beta Users",
      "creator": "alice@example.com",
      "created": "2020-10-22T14:06:25.897Z",
      "url": "https://app.fullstory.com/ui/yourOrgId/segments/12345abcdefg"
    },
    {
      "id": "hijklmn12345",
      "name": "Power Users (Web)",
      "creator": "joe@example.com",
      "created": "2020-10-22T13:35:04.700Z",
      "url": "https://app.fullstory.com/ui/yourOrgId/segments/hijklmn12345"
    }
  ],
  "nextPaginationToken": "abdefg123"
}

Loading...