List segments

Request schema

Path parameters

source_id

integerrequired

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

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

default:

per_page

number

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

default:

maximum:

100

order

string

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

default:

desc

enum:

"asc""desc"

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

Http + 1.1

GET

https://app.getcensus.com/api/v1/sources/{source_id}/filter_segments

GET /api/v1/sources/{source_id}/filter_segments?name=SOME_STRING_VALUE&page=SOME_NUMBER_VALUE&per_page=SOME_NUMBER_VALUE&order=SOME_STRING_VALUE HTTP/1.1
Authorization: Bearer REPLACE_BEARER_TOKEN
Host: app.getcensus.com

Responses

200

Successfully retrieved the list of segments.

`200`

status

stringrequired

The outcome of the request

enum:

"success"

pagination

objectrequired

An object to help you navigate the list of results.

total_records

number

Total records in the collection.

example:

per_page

number

Records on each page.

default:

example:

prev_page

number | null

The previous page number, or null for the first page.

example:

page

number

The current page number.

default:

example:

next_page

number | null

The next page number, or null if it's the last page.

example:

last_page

number

The number of the last page with records.

example:

data

arrayrequired

The list of results.

type

string

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

enum:

"segment"

integer

The id of this segment.

example:

name

string

The name of this segment.

example:

priority accounts

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)

example:

dataset_id

integer

The dataset ID that this segment is associated with.

example:

query

string

The SQL query associated with this segment.

example:

SELECT * FROM ( SELECT 1 AS id, 'Planet Express'::text AS company_name ) AS census_1d19740e93f711b22efaea201fcf3f8f WHERE ("id" IS NOT NULL )

record_count

integer

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

example:

12540

created_at

string

When this segment was created.

format:

date-time

example:

2021-10-20T02:43:07.120Z

updated_at

string

When this segment was last updated.

format:

date-time

example:

2021-10-20T02:50:35.477Z

resource_identifier

string

The unique identifier for this filter segment.

example:

segment:priority-accounts

molecules

array

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

A condition on an property of an entity. The property or column will belong to the entity described in the parent relationship molecule. If the basic molecule is top level, the condition is on the entity on which the segment is based on.

attribute

string

Represents the property name when attribute_type is property and the column name when attribute_type is column.

example:

last_seen_at

attribute_type

string

The type of the attribute for this condition. Options are:

property for entity properties
sql for sql conditions
column for legacy segments

enum:

"property""sql""column"

operator

string

The operator for this molecule. Only certain operators will be valid for a given property type. For example, the greaterthan operator can only be applied to numeric values.

enum:

"isnull""isnotnull""between""in""exactly""isnot""starts""ends""contains""nocontains""isblank""isnotblank""equals""notexactly""lessthan""greaterthan""intop""inbottom""true""false""morethandays""lessthandays""exactlydays""after""on""before"

value

string

If the attribute_type is sql, then this is a SQL string. Otherwise the value being filtered on.

a number for numerical operators
a string for string operators
a boolean for boolean operators
an array for array operators
for datetime operators, this could either be a datetime value, a number (for “morethandays” type operators), or a “between” value which is represented as a hash with the following structure { bound_one: X, bound_two: Y }. X and Y are either datetime values, blank (in which case they become the current datetime on the backend), or a string with the following structure "days_ago: Z" where Z is a number (can be decimal).

example:

A condition based on including or excluding a related segment based off of the same entity.

filter_segment_id

integer

The id of the related Segment

example:

is_member

boolean

Condition to include or exclude members of the related filter segment

example:

true

A condition or set of conditions on a related entity.

relationship_id

integer

ID for the relationship object that connects both entities

example:

455

constraint

object

Used only for creating conditions on event entities.

type

string

The type of constraint, will always be occurrences.

enum:

"occurrences"

operator

string

The operator to apply to the event constraint

enum:

"atleast""equals""atmost""anynumber"

value

integer

The value to apply to the operator

example:

negate

boolean

Whether the constraint should be negated

example:

true

molecules

array

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

filter_segment_source_object_id

integer

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

deprecated:

true

example:

cohorts

array

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

integer

The id of this cohort.

example:

name

string

The name of this cohort.

example:

Treatment A

percentage

number

The percentage of users included in this cohort.

format:

integer

maximum:

100

example:

is_control

boolean

Will be true if this is the control cohort, false if it is a treatment.

created_at

string

When this cohort was created.

format:

date-time

example:

2021-10-20T02:43:07.120Z

resource_identifier

string

The unique identifier for this cohort.

example:

cohort:treatment-a

{
  "status": "success",
  "pagination": {
    "total_records": 14,
    "per_page": 25,
    "prev_page": 1,
    "page": 2,
    "next_page": 3,
    "last_page": 10
  },
  "data": [
    {
      "type": "segment",
      "id": 18,
      "name": "priority accounts",
      "model_id": 9,
      "dataset_id": 12,
      "query": "SELECT * FROM (\n  SELECT 1 AS id, 'Planet Express'::text AS company_name\n) AS census_1d19740e93f711b22efaea201fcf3f8f\nWHERE (\"id\" IS NOT NULL )\n",
      "record_count": 12540,
      "created_at": "2021-10-20T02:43:07.120Z",
      "updated_at": "2021-10-20T02:50:35.477Z",
      "resource_identifier": "segment:priority-accounts",
      "molecules": [
        {
          "attribute": "last_seen_at",
          "attribute_type": "property",
          "operator": "isnotnull",
          "value": "id"
        }
      ],
      "filter_segment_source_object_id": 32,
      "cohorts": [
        {
          "id": 18,
          "name": "Treatment A",
          "percentage": 50,
          "is_control": true,
          "created_at": "2021-10-20T02:43:07.120Z",
          "resource_identifier": "cohort:treatment-a"
        }
      ]
    }
  ]
}