/
Retrieve a segment

Retrieve a segment

Request

Retrieves a UI segment with a specified ID.

Security
SecretApiKey or JWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required

ID of the resource.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/grid-segments/{id}' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Segment retrieved.

Headers
Pagination-Totalinteger

Total number of items.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

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
Bodyapplication/json
idstring, <= 50 charactersread-only

ID of the segment.

Example:"grd_seg_0YVCNRJW0ADV49TN8BD9X91XB5"
ownerobjectread-onlyrequired

Creator of segment.

dataobjectrequired

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.

isStarredboolean

Specifies if 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.

isVisibleboolean

Specifies if the segment is visible to the current user.

usersArray of objects, uniqueread-only

List of user details with which this segment is shared.

scopestringrequired

Controls the visibility of the segment.

Enum ValueDescription
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.

Response
{
  "id": "grd_seg_0YVCNRJW0ADV49TN8BD9X91XB5",
  "owner": {
    "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
    "name": "string"
  },
  "data": {
    "name": "string",
    "columns": [ … ],
    "filters": "averageValue/amount:10;bin:555,2058",
    "page": "data-tables",
    "sort": "string",
    "type": "customers"
  },
  "isStarred": true,
  "isVisible": true,
  "users": [
    { … }
  ],
  "scope": "private"
}