Update model

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

Update certain values of a specified model

Request schema

Path parameters

source_id

integerrequired

ID of the source

model_id

integerrequired

ID of the model

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

Request

name

string

The name of this model.

example:

New App Users

query

string

The SQL query associated with this model.

example:

SELECT * FROM "users"

description

string

The description for this model.

example:

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

Http + 1.1

PATCH

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

PATCH /api/v1/sources/{source_id}/models/{model_id} HTTP/1.1
Authorization: Bearer REPLACE_BEARER_TOKEN
Content-Type: application/json
Host: app.getcensus.com
Content-Length: 147

{
  "name": "New App Users",
  "query": "SELECT * FROM \"users\"",
  "description": "Users that have signed up for our product in the last week."
}

Responses

200

Successfully updated the model

`200`

status

string

Outcome of the operation.

enum:

"success""updated""created""not_found""error"

data

object

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:

refresh_key

integer

They key that can be used to check the status of the refresh job, which is run automatically when the model query is updated.

example:

1647978948

{
  "status": "updated",
  "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
  },
  "refresh_key": 1647978948
}