Onvo Documentation
Concepts
Data Sources

Data sources

A data source identifies some data stream that can be used to build dashboards. It could be an API, a file, or one of our many integrations.

Data source fields

title
string
required

The title or name of the datasource.

description
string

A description of the datasource.

created_at
string

The timestamp indicating when the datasource was created.

created_by
string

The identifier of the user who created the datasource.

id
string

The unique identifier for the datasource.

columns
array
required

An array of objects representing columns in the datasource. Each object has a 'title' and 'description'.

config
object
required

The configuration object associated with the datasource.

{
    url: string;
    type: "json" | "csv" | "xml" | "excel";
    method: "GET" | "POST";
    headers?: string;
    body?: string;
    transform?: string;
}
last_updated_at
string

The timestamp indicating when the datasource was last updated.

last_updated_by
string

The identifier of the user who last updated the datasource.

parameters
array
required

An array of objects representing parameters in the datasource. Each object has an 'id', 'wrap' and 'default'.

sample_data
string

Sample data associated with the datasource.

size
number

The size of the datasource in kB.

source
string
required

The source of the datasource. It can be of type api, file, mongodb, sql, redshift, postgresql, firestore, airtable, google-sheet, zoho-people, quickbooks, zoho-books, zero, sage, tally, wafeq, wave, myob or ms-dynamics

team
string

The identifier of the team to which the datasource belongs.