List segments - Census API Reference

Product Docs

Engineering Blog

Introduction

Organization APIs

Users
Invitations
Workspaces

Workspace APIs

Syncs
Sync Management Links
Sync Runs
Destination Types
Destinations
Destination Connect Links
Source Types
Sources
- GET
  List sources
- POST
  Create a new source
- GET
  Fetch source
- PATCH
  Update source
- DEL
  Delete source
- Objects
- Models
- Topics
- Tables
- Segments
- Projects
Source Connect Links
Segment Management Links
Webhooks

GET

sources

{source_id}

filter_segments

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

{
  "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"
        }
      ]
    }
  ]
}

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:1

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

per_page

number

default:25

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

Example:

"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

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

When this segment was created.

Example:

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

data.updated_at

string

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.

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

Was this page helpful?

Raise issue

Check column refresh Create a new segment

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

{
  "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"
        }
      ]
    }
  ]
}