List segments

Authorizations

Authorization

string

header

required

Bearer token for the current workspace. Can be retrieved from the Workspace's settings page.

Path Parameters

source_id

integer

required

ID of the source

Query Parameters

name

string

A partial or full name to search for matching filter segments. Supports case-insensitive and fuzzy matching.

page

number

default:

Designates which page of results to return. Always starts at 1. If 0 is specified, it defaults to 1.

per_page

number

default:

Determines the number of results on each page. It can't exceed 100.

Required range: x < 100

order

enum<string>

default:

desc

Organizes the results based on their creation time, either ascending or descending.

Available options:

asc,

desc

Response

200 - application/json

Successfully retrieved the list of segments.

A successfully fetched list of results.

status

enum<string>

required

The outcome of the request

Available options:

success

pagination

object

required

An object to help you navigate the list of results.

data

object[]

required

The list of results.

data.type

enum<string>

The type of this source object, will always be segment.

Available options:

segment

data.id

integer

The id of this segment.

data.name

string

The name of this segment.

data.model_id

integer

The id of the model that this filter segment is related to (either directly from legacy segments or indirectly via the dataset)

data.dataset_id

integer

The dataset ID that this segment is associated with.

data.query

string

The SQL query associated with this segment.

data.record_count

integer

The cached size of the segment at that particular moment in time.

data.created_at

string

When this segment was created.

data.updated_at

string

When this segment was last updated.

data.resource_identifier

string

The unique identifier for this filter segment.

data.molecules

object[]

A list of Atomic Molecules, Related Segment Molecules, Relationship Molecules, Molecule Groups and at most one Operation Molecule.

data.filter_segment_source_object_id

integer

deprecated

[Deprecated] The source object id for this segment. You can typically ignore this.

data.cohorts

object[]

A list of cohorts (experiments) that are active for this segment

Introduction

Organization APIs

Workspace APIs

Authorizations

Path Parameters

Query Parameters

Response