Sources
This endpoint will list all of your data sources, such as your connected data warehouse. For information on models and tables associated with a source, query the endpoints for
data_sources, models, and tables as described below.Request
Response
curl 'https://app.getcensus.com/api/v1/sources' \
--header 'Authorization: Bearer [API_TOKEN]'
{
"status": "success",
"data": [
{
"id": 4,
"name": "Snowflake - xxxxxxx.us-east-1",
"label": null,
"type": "snowflake",
"last_test_succeeded": null,
"last_tested_at": null,
"connection_details": {
"account": "xxxxxxx.us-east-1",
"user": "DEV",
"warehouse": "TEST",
"use_keypair": false
},
"read_only_connection": false
},
{
"id": 10,
"name": "BigQuery - Development",
"label": "BigQuery",
"type": "big_query",
"last_test_succeeded": true,
"last_tested_at": "2021-10-07T20:02:19.544Z",
"connection_details": {
"project_id": "development",
"location": "US",
"service_account": "xxxxxx.iam.gserviceaccount.com",
"location_editable": false
},
"read_only_connection": false
}
],
"next": "https://app.getcensus.com/api/v1/sources?page=2&per_page=2",
"pagination": {
"total_records": 4,
"per_page": 2,
"prev_page": null,
"page": 1,
"next_page": 2,
"last_page": 2
}
}
Data Property | Description |
|---|---|
List of sources | A list containing information on each source. The properties of a source are described in the next endpoint. |
This endpoint lists information on a specific source.
Request
Response
curl 'https://app.getcensus.com/api/v1/sources/[ID]' \
--header 'Authorization: Bearer [API_TOKEN]'
{
"status": "success",
"data": {
"id": 4,
"name": "Snowflake - xxxxxxx.us-east-1",
"label": null,
"type": "snowflake",
"last_test_succeeded": null,
"last_tested_at": null,
"connection_details": {
"account": "xxxxxxx.us-east-1",
"user": "DEV",
"warehouse": "TEST",
"use_keypair": false
},
"read_only_connection": false
}
}
Data Property | Description |
|---|---|
id | The id of this source. |
name | The name of this source. |
label | The label assigned to this source. |
type | The type of this source (e.g. redshift, big_query) |
last_test_succeeded | Whether or not the last connection test on this source was successful. |
last_tested_at | When the last connection test was ran on this source. |
connection_details | Connection details associated with this source. |
read_only_connection | Whether or not Census has write permissions, for tracking sync state, on this source. |
data_sources | A list of models and tables associated with this source. Model and table properties are described in their respective endpoints below. |
This endpoint creates a source with the given data.
Request
Response
curl --location --request POST 'https://app.getcensus.com/api/v1/sources' \
--header 'Authorization: Bearer [API_TOKEN]' \
--header 'Content-Type: application/json' \
--data-raw '{
"connection": {
"credentials": {
"hostname": "<instance>.<region>.redshift.amazonaws.com",
"port": "5439",
"user": "redshift_user",
"password": "redshift_password",
"database": "demo"
},
"label": "Example Redshift Source",
"type": "redshift"
}
}'
{
"status": "created",
"data": {
"id": 12345
}
}
Request Property | Description |
|---|---|
connection | Contains the information for the connection. |
Connection Property | Description |
|---|---|
type | required. The type of this source (e.g. redshift, big_query) |
credentials | required. Credentials that should be associated with this source (e.g. hostname, port) |
label | The label assigned to this source. |
read_only_connection | Whether or not Census has write permissions, for tracking sync state, on this source. |
This endpoint updates a source with the given data.
Request
Response
curl --location --request PATCH 'https://app.getcensus.com/api/v1/sources/12' \
--header 'Authorization: Bearer [API_TOKEN]' \
--header 'Content-Type: application/json' \
--data-raw '{
"connection": {
"credentials": {
"database": "demo_v2"
},
"label": "Redshift (Demo v2)"
}
}'
{
"status": "updated",
"data": {
"id": 6,
"name": "Redshift (Demo v2)",
"label": "Redshift (Demo v2)",
"last_test_succeeded": true,
"last_tested_at": "2022-01-01T00:00:00.000Z",
"type": "redshift",
"connection_details": {
"user": "redshift_user",
"hostname": "<instance>.<region>.redshift.amazonaws.com",
"port": 5439,
"database": "demo_v2",
"ssh_tunnel_enabled": null,
"ssh_tunnel_hostname": null,
"ssh_tunnel_port": null,
"ssh_tunnel_user": null,
"ssh_tunnel_public_key": null
},
"read_only_connection": false
}
}
Request Property | Description |
|---|---|
connection | Contains the information for the connection. |
Connection Property | Description |
|---|---|
credentials | Credentials that should be associated with this source (e.g. hostname, port) |
label | The label assigned to this source. |
read_only_connection | Whether or not Census has write permissions, for tracking sync state, on this source. |
This endpoint deletes a source with the given ID.
Request
Response
curl --request DELETE 'https://app.getcensus.com/api/v1/sources/6' \
--header 'Authorization: Bearer [API_TOKEN]'
{
"status": "deleted"
}
Response Property | Description |
|---|---|
status | deleted or 404 indicating whether the model was found and deleted. |
This endpoint queues a job to refresh the list of tables for a source.
Request
Response
curl --request POST 'http://app.getcensus.com/api/v1/sources/[ID]/refresh_tables' \
--header 'Authorization: Bearer [API_TOKEN]'
{
"refresh_key": 1647978948
}
Response Property | Description |
|---|---|
refresh_key | Contains an id used to query the refresh tables job. |
This endpoint checks whether the the job refreshing tables for a source has completed.
Request
Response
curl 'https://app.getcensus.com/api/v1/sources/[ID]/refresh_tables_status?refresh_key=[refresh_key]' \
--header 'Authorization: Bearer [API_TOKEN]'
{
"status": "completed"
}
Query Parameter | Description |
|---|---|
refresh_key | required. An id provided by the refresh_tables endpoint, used to check whether the refresh tables job has finished. |
Response Property | Description |
|---|---|
status | Status of the job. Can be either completed or processing. |
Last modified 1mo ago