List models

⚠️ DEPRECATED: This endpoint is deprecated and will be removed in a future version. Please migrate to the new Datasets API instead.

Request schema

Path parameters

source_id

integerrequired

ID of the source

Query parameters

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}/models

GET /api/v1/sources/{source_id}/models?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 models.

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

enum:

"model"

integer

The id of this model.

example:

name

string

The name of this model.

example:

New App Users

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:

description

string

The description for this model.

example:

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

query

string

The SQL query associated with this model.

example:

SELECT * FROM "users"

created_at

string

When this model was created.

format:

date-time

example:

2021-10-20T02:43:07.120Z

updated_at

string

When this model was last updated.

format:

date-time

example:

2021-10-20T02:50:35.477Z

compiled_query

string | null

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

columns

array

A list of columns from this model.

name

string

The name of the column.

example:

type

string

The data type of the column.

example:

character varying (256)

dataset_id=

integer | null

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

deprecated:

true

example:

source_object_id

integer

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

deprecated:

true

example:

{
  "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": "string",
      "columns": [
        {
          "name": "user_id",
          "type": "character varying (256)"
        },
        {
          "name": "full_name",
          "type": "character varying (256)"
        }
      ],
      "dataset_id=": 12,
      "source_object_id": 20
    }
  ]
}