This endpoint gets or creates a new customer. If a customer with the given provided_id does not exist, a new customer will be created. The response contains the created or already-existing customer and a flag denoting whether a new customer was created.
The ID you use to identify this customer in your database. 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.
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.
A boolean representing whether this customer is a “demo customer.” Setting this to true will make
data panels include a demo watermark for the customer. Demo customers do not count towards paid
customers. Default value is false.
An array of group tag names to assign to the customer. Group tag names must be of existing group
tags, and these can be created with the create_group_tag endpoint.
The name of the hierarchy level to assign to the customer. Must be an existing hierarchy level. If
no level is specified, the created customer will be assigned to the root (highest) level of the
hierarchy. If you do not have a hierarchy set up and would like one, reach out to customer
support.
An identifier for a parent customer matching the parent’s provided_id. If provided, the customer
will be set as a child of the parent customer, and will have its computed_properties and
computed_parent_schema_datasource_mapping fields inherit values from the parent customer.
Parents must belong to the same data visibility group as their children. Parents must also be at a
strictly higher hierarchy level than their children, so you’ll need to explicitly set the
hierarchy_level_name to be at a level below the parent’s level. You can contact customer support
to set up a hierarchy for your customers.
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.
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.
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.
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.
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.
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.
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/create_customer/'\--header'Content-Type: application/json'\--header'Explo-Authorization: Token <token>'\--data-raw '{"provided_id":"example_1","name":"Example 1","mapping":{"40":"213", "134":"386"},"properties":{"filterValue":"value"},"emails":["[email protected]"],"group_tags":["sales"],"hierarchy_level_name":"Customer"}'
