List datasets

List datasets

curl --request GET \
  --url https://app.getcensus.com/api/v1/datasets \
  --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": "sql",
      "query": "SELECT id, name, email FROM users WHERE active = true",
      "source_id": 123,
      "name": "Users",
      "id": 157,
      "resource_identifier": "dataset:users",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "description": "This dataset contains golden user records",
      "cached_record_count": 123,
      "columns": [
        {
          "name": "email",
          "data_type": "string",
          "can_be_upsert_key": true
        }
      ]
    }
  ]
}

GET

datasets

List datasets

curl --request GET \
  --url https://app.getcensus.com/api/v1/datasets \
  --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": "sql",
      "query": "SELECT id, name, email FROM users WHERE active = true",
      "source_id": 123,
      "name": "Users",
      "id": 157,
      "resource_identifier": "dataset:users",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "description": "This dataset contains golden user records",
      "cached_record_count": 123,
      "columns": [
        {
          "name": "email",
          "data_type": "string",
          "can_be_upsert_key": true
        }
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer token for the current workspace. Can be retrieved from the Workspace's settings page.

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

type

enum<string>

Filter datasets by type. Supports "sql".

Available options:

sql

Response

Successfully retrieved the list of datasets.

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.

Show child attributes

pagination.total_records

number

Total records in the collection.

Example:

14

pagination.per_page

number

default:25

Records on each page.

Example:

25

pagination.prev_page

number | null

The previous page number, or null for the first page.

Example:

1

pagination.page

number

default:1

The current page number.

Example:

2

pagination.next_page

number | null

The next page number, or null if it's the last page.

Example:

3

pagination.last_page

number

The number of the last page with records.

Example:

10

data

SQL · object[]

required

The list of results.

Show child attributes

data.type

enum<string>

default:sql

required

Type of dataset

Available options:

sql

data.query

string

required

SQL query that defines the dataset

Example:

"SELECT id, name, email FROM users WHERE active = true"

data.source_id

integer

required

ID of the source connection

Example:

123

data.name

string

required

The name of the dataset

Example:

"Users"

data.id

integer

required

Unique identifier for the dataset

Example:

157

data.resource_identifier

string

required

Resource identifier for the dataset

Example:

"dataset:users"

data.created_at

string<date-time>

required

Timestamp when the dataset was created

data.updated_at

string<date-time>

required

Timestamp when the dataset was last updated

data.description

string

Optional description of the dataset

Example:

"This dataset contains golden user records"

data.cached_record_count

integer

Cached count of records in the dataset

data.columns

object[]

List of columns in the dataset

Show child attributes

data.columns.name

string

required

The name of the column

Example:

"email"

data.columns.data_type

string

required

The data type of the column

Example:

"string"

data.columns.can_be_upsert_key

boolean

required

Indicates if the column can be used as an upsert key

Example:

true

Check project refresh status Create a new dataset

⌘I

Introduction

Organization APIs

Workspace APIs

Authorizations

Query Parameters

Response