Skip to main content
GET
/
v1
/
thin_viz
/
default_schema
/
{schema_name}
cURL
curl --request GET \
  --url https://trytako.com/api/v1/thin_viz/default_schema/{schema_name}/ \
  --header 'X-API-Key: <api-key>'
{
  "name": "<string>",
  "description": "<string>",
  "components": [
    "header"
  ],
  "component_templates": [
    {
      "component_type": "header",
      "required_fields": {},
      "optional_fields": {},
      "example": {}
    }
  ]
}

Notes

  • To authenticate, you’ll need a Tako API key. It’s best practice to store it as an environment variable to avoid hardcoding sensitive credentials in your code.
  • Returns a default schema by its name with template information showing required and optional fields for each component type.
  • The schema_name parameter should be the unique identifier of the default schema (e.g., ‘modelml__stock_card’).

Authorizations

X-API-Key
string
header
required

Path Parameters

schema_name
string
required

Name of the default schema (e.g., 'modelml__stock_card')

Response

Default schema with component templates

Response for GET /thin_viz/default_schema/{name} with template information.

name
string
required

Schema name (unique identifier)

description
string
required

Schema description

components
enum<string>[]
required

List of component types

Available component types for thin viz cards.

Each component type has a dedicated builder that processes configurations, adds defaults, and applies theme styling automatically.

Available options:
header,
generic_timeseries,
categorical_bar,
data_table_chart,
financial_boxes,
table,
choropleth,
heatmap,
histogram,
pie,
scatter,
boxplot,
treemap,
waterfall,
bubble
component_templates
ComponentTemplate · object[]
required

Template information for each component