Request free trial
Take a tour
Request free trial

Create Blueprint

Documentation
API Reference
Case Studies
Security Trust Center
Changelog

Create Blueprint

POST

api

create_blueprint

Explo-Authorization

string

Explo-Authorization

Required

string

object

customer_id

string

customer_id

Required

string

This is your unique identifier for your customer

blueprint_name

string

blueprint_name

Required

string

This is what the blueprint will be named

tables

object

tables

Required

object

List of tables and column information associated with the customer

table_name

string

table_name

Required

string

Name of the table. Query will be “SELECT * FROM table_name”

schema_id

number

schema_id

Required

number

Schema this table is attached to.

query

string

query

string

Query to override the default “SELECT * FROM table_name”. Optional parameter.

columns

object

columns

Required

object

List of columns in this table

name

string

name

Required

string

Name of table column

type

string

type

Required

string

The type of the column. Has to be one of INTEGER, FLOAT, BOOLEAN, STRING, DATETIME, TIMESTAMP, or DATE

display_name

string

display_name

string

Display name for column. If not provided, name will be used

can_be_grouped

boolean

can_be_grouped

boolean

If column can be used to group data in charts

dataset_name

string

dataset_name

string

Name of dataset supplied to customers. If null, table_name will be used

description

string

description

string

Description of dataset for customers

This endpoint creates a new blueprint.

Body

customer_id

string

required

This is your unique identifier for your customer

blueprint_name

string

required

This is what the blueprint will be named

tables

object

required

List of tables and column information associated with the customer

table_name

string

required

Name of the table. Query will be “SELECT * FROM table_name”

schema_id

number

required

Schema this table is attached to.

query

string

Query to override the default “SELECT * FROM table_name”. Optional parameter.

columns

object

required

List of columns in this table

name

string

required

Name of table column

type

string

required

The type of the column. Has to be one of INTEGER, FLOAT, BOOLEAN, STRING, DATETIME, TIMESTAMP, or DATE

display_name

string

Display name for column. If not provided, name will be used

can_be_grouped

boolean

default: "true"

If column can be used to group data in charts

dataset_name

string

Name of dataset supplied to customers. If null, table_name will be used

description

string

Description of dataset for customers

Response

success

number

Indicates whether the call was successful. 1 if successful, 0 if not.

blueprint_id

number

The id of the new blueprint

API Documentation

Customer API

Resource API

Partners API

Group Tag API

End User API [Deprecated]

End User Group API [Deprecated]

​Body

​Response

Body

Response