Retrieve a segment

Retrieves a UI segment with a specified ID.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

Resource identifier string.

Responses
200

Segment retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
data
required
object

Object that contains a schema that is used to set up the UI for the segment. This schema is built and consumed by the frontend. It includes information such as: segment name, UI settings, and so on.

required
object

Creator of segment.

id
string <= 50 characters

User ID of the creator.

name
string

First and last name of the creator.

scope
required
string

Controls the visibility of the segment.

Enum: Description
private

Visible only to the owner the segment.

public

Visible to all in the owner's organization.

shared

Visible to a specific group of users that are specified in the userIds field.

id
string <= 50 characters

ID of the segment.

isStarred
boolean

Specifies whether this segment is starred by the current user. Starring a segment marks it as a favorite segment, and also adds the segment to a starred folder in the UI.

isVisible
boolean

Specifies whether the segment is visible to the current user.

Array of objects unique

List of user details with which this segment is shared.

Array
id
string <= 50 characters

User ID.

name
string

First and last name.

403

Access forbidden.

404

Resource not found.

get/grid-segments/{id}
Request samples
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "owner": {
    },
  • "data": { },
  • "isStarred": true,
  • "isVisible": true,
  • "users": [
    ],
  • "scope": "private"
}