Fetch segment

Fetch segment

curl --request GET \
  --url https://app.getcensus.com/api/v1/sources/{source_id}/filter_segments/{segment_id} \
  --header 'Authorization: Bearer <token>'

{
  "status": "success",
  "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"
      }
    ]
  }
}

GET

sources

{source_id}

filter_segments

{segment_id}

Fetch segment

curl --request GET \
  --url https://app.getcensus.com/api/v1/sources/{source_id}/filter_segments/{segment_id} \
  --header 'Authorization: Bearer <token>'

{
  "status": "success",
  "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"
      }
    ]
  }
}

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

segment_id

integer

required

ID of the segment

Response

200 - application/json

Successfully retrieved the segment

status

enum<string>

Outcome of the operation.

Available options:

success,

updated,

created,

not_found,

error

Example:

"success"

data

object

Show child attributes

data.type

enum<string>

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

Available options:

segment

Example:

"segment"

data.id

integer

The id of this segment.

Example:

18

data.name

string

The name of this segment.

Example:

"priority accounts"

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)

Example:

9

data.dataset_id

integer

The dataset ID that this segment is associated with.

Example:

12

data.query

string

The SQL query associated with this segment.

Example:

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

data.record_count

integer

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

Example:

12540

data.created_at

string<date-time>

When this segment was created.

Example:

"2021-10-20T02:43:07.120Z"

data.updated_at

string<date-time>

When this segment was last updated.

Example:

"2021-10-20T02:50:35.477Z"

data.resource_identifier

string

The unique identifier for this filter segment.

Example:

"segment:priority-accounts"

data.molecules

object[]

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.

Option 1
Option 2
Option 3

Show child attributes

data.molecules.attribute

string

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

Example:

"last_seen_at"

data.molecules.attribute_type

enum<string>

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

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

Available options:

property,

sql,

column

Example:

"property"

data.molecules.operator

enum<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.

Available options:

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

Example:

"isnotnull"

data.molecules.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:

"id"

data.filter_segment_source_object_id

integer

deprecated

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

Example:

32

data.cohorts

object[]

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

Show child attributes

data.cohorts.id

integer

The id of this cohort.

Example:

18

data.cohorts.name

string

The name of this cohort.

Example:

"Treatment A"

data.cohorts.percentage

number<integer>

The percentage of users included in this cohort.

Required range: 0 <= x <= 100

Example:

50

data.cohorts.is_control

boolean

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

data.cohorts.created_at

string<date-time>

When this cohort was created.

Example:

"2021-10-20T02:43:07.120Z"

data.cohorts.resource_identifier

string

The unique identifier for this cohort.

Example:

"cohort:treatment-a"

Create a new segment Update segment

⌘I

Introduction

Organization APIs

Workspace APIs

Authorizations

Path Parameters

Response