curl --location --request POST 'https://api.explo.co/api/get_customer/' \
--header 'Content-Type: application/json' \
--header 'Explo-Authorization: Token <token>' \
--data-raw '{
"provided_id": "example_1"
}'
{
"success": 1,
"customer": {
"token": "<customer_token_to_auth_dashboard>",
"name": "Example 1",
"provided_id": "example_1",
"is_demo_group": false,
"emails": ["[email protected]"],
"group_tags": ["sales"],
"properties": { "filterValue": "value" },
"computed_properties": { "filterValue": "value" },
"access_group": "Production",
"parent_schema_datasource_mapping": {"40": "213": "134": 386"},
"computed_parent_schema_datasource_mapping": {"40": "213": "134": 386"},
"hierarchy_level": "Customer"
}
}
Customer API
Get Customer
POST
/
api
/
get_customer
/
curl --location --request POST 'https://api.explo.co/api/get_customer/' \
--header 'Content-Type: application/json' \
--header 'Explo-Authorization: Token <token>' \
--data-raw '{
"provided_id": "example_1"
}'
{
"success": 1,
"customer": {
"token": "<customer_token_to_auth_dashboard>",
"name": "Example 1",
"provided_id": "example_1",
"is_demo_group": false,
"emails": ["[email protected]"],
"group_tags": ["sales"],
"properties": { "filterValue": "value" },
"computed_properties": { "filterValue": "value" },
"access_group": "Production",
"parent_schema_datasource_mapping": {"40": "213": "134": 386"},
"computed_parent_schema_datasource_mapping": {"40": "213": "134": 386"},
"hierarchy_level": "Customer"
}
}
This endpoint gets an existing customer.
Body
string
The ID you use to identify this customer in your database. This is also the ID
you use to reference your customer in Explo queries or access your customer
via the API. For more information on example usage, check out this
section.
Response
number
Indicates whether the call was successful. 1 if successful, 0 if not.
object
The contents of the customer
Show Toggle object
Show Toggle object
string
The customer token (customerToken or CUSTOMER_TOKEN) that will be used to
identify which customer is viewing the dashboard. You should save this on your
end to use when rendering an embedded dashboard by passing this token into the
web component or iframe. Example usage
here.
string
The display name you provided for your customer in Explo.
string
The ID you use to identify this customer in your database that you provided.
This is also the ID you will use to reference your customer in Explo queries
or access your customer via the API. For more information on example usage,
check out this section.
object
An array of email addresses you provided for your customer.
object
An array of group tag names that have been assigned to this customer.
string
The name of the assigned hierarchy level.
string or null
If present, the name of the assigned data visibility group.
boolean
True if this customer is a demo customer, which means that data panels will
include a demo watermark for the customer. Demo customers do not count towards
paid customers.
JSON or null
A set of key-value pairs assigned to this customer. These will be accessible
through variables in the dashboards and SQL editor. More information on
properties can be found in this
section.
JSON
A properties object based on the provided properties of this customer and any
inherited properties from parent customers.
JSON | Null
A set of key-values pairs that map a schema id to the data source that this
customer loads data from. For more information on schemas and data sources,
check out this section.
JSON
A schema datasource mapping object based on the
parent_schema_datasource_mapping of the customer and any inherited
parent_schema_datasource_mapping from parent customers.
curl --location --request POST 'https://api.explo.co/api/get_customer/' \
--header 'Content-Type: application/json' \
--header 'Explo-Authorization: Token <token>' \
--data-raw '{
"provided_id": "example_1"
}'
{
"success": 1,
"customer": {
"token": "<customer_token_to_auth_dashboard>",
"name": "Example 1",
"provided_id": "example_1",
"is_demo_group": false,
"emails": ["[email protected]"],
"group_tags": ["sales"],
"properties": { "filterValue": "value" },
"computed_properties": { "filterValue": "value" },
"access_group": "Production",
"parent_schema_datasource_mapping": {"40": "213": "134": 386"},
"computed_parent_schema_datasource_mapping": {"40": "213": "134": 386"},
"hierarchy_level": "Customer"
}
}