List models - 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

GET

sources

{source_id}

models

curl --request GET \
  --url https://app.getcensus.com/api/v1/sources/{source_id}/models \
  --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": "model",
      "id": 18,
      "name": "New App Users",
      "dataset_id": 12,
      "description": "Users that have signed up for our product in the last week.",
      "query": "SELECT * FROM \"users\"",
      "created_at": "2021-10-20T02:43:07.120Z",
      "updated_at": "2021-10-20T02:50:35.477Z",
      "compiled_query": null,
      "columns": [
        {
          "name": "user_id",
          "type": "character varying (256)"
        },
        {
          "name": "full_name",
          "type": "character varying (256)"
        }
      ],
      "dataset_id=": 12,
      "source_object_id": 20
    }
  ]
}

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

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

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

Available options:

model

Example:

"model"

data.id

integer

The id of this model.

Example:

18

data.name

string

The name of this model.

Example:

"New App Users"

data.dataset_id

integer | null

The identifier for the dataset that corresponds to this model. A model will always have a corresponding dataset unless the model belongs to a dbt, looker, sigma recipe that has not been used in Census

Example:

12

data.description

string

The description for this model.

Example:

"Users that have signed up for our product in the last week."

data.query

string

The SQL query associated with this model.

Example:

"SELECT * FROM \"users\""

data.created_at

string

When this model was created.

Example:

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

data.updated_at

string

When this model was last updated.

Example:

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

data.compiled_query

string | null

The compiled query associated with this model if it is built atop a DBT instance.

Example:

null

data.columns

object[]

A list of columns from this model.

Example:

[
  {
    "name": "user_id",
    "type": "character varying (256)"
  },
  {
    "name": "full_name",
    "type": "character varying (256)"
  }
]

data.dataset_id=

integer | null

deprecated

[Deprecated] Identical to dataset_id but with a typo. Will be removed in a future version.

Example:

12

data.source_object_id

integer

deprecated

[Deprecated] The source object ID for this model. You can typically ignore this.

Example:

20

Was this page helpful?

Raise issue

List source objects Create a new model

curl --request GET \
  --url https://app.getcensus.com/api/v1/sources/{source_id}/models \
  --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": "model",
      "id": 18,
      "name": "New App Users",
      "dataset_id": 12,
      "description": "Users that have signed up for our product in the last week.",
      "query": "SELECT * FROM \"users\"",
      "created_at": "2021-10-20T02:43:07.120Z",
      "updated_at": "2021-10-20T02:50:35.477Z",
      "compiled_query": null,
      "columns": [
        {
          "name": "user_id",
          "type": "character varying (256)"
        },
        {
          "name": "full_name",
          "type": "character varying (256)"
        }
      ],
      "dataset_id=": 12,
      "source_object_id": 20
    }
  ]
}