Explo | Customer-facing analytics for any platform

curl --location --request GET 'https://api.explo.co/v2/api/customers/?pageSize=2&page=1' \
--header 'Content-Type: application/json' \
--header 'Explo-Authorization: Token <token>'

{
  "total_count": 10,
  "results": {
    "customers": [
      {
        "token": "<customer_token_to_auth_dashboard>",
        "name": "Example 1",
        "provided_id": "example_1",
        "is_demo_group": false,
        "emails": ["[email protected]"],
        "group_tags": ["designers", "engineers"],
        "properties": { "filter_value": "value" },
        "computed_properties": { "filter_value": "value" },
        "access_group": "Development",
        "parent_schema_datasource_mapping": { "40": "213", "134": "386" },
        "computed_parent_schema_datasource_mapping": { "40": "213", "134": "386" },
        "hierarchy_level": "Level 1"
      },
      {
        "token": "<customer_token_to_auth_dashboard>",
        "name": "Example 2",
        "provided_id": "example_2",
        "is_demo_group": false,
        "emails": ["[email protected]"],
        "group_tags": [],
        "properties": { "filter_value": "value" },
        "computed_properties": { "filter_value": "value" },
        "access_group": "Production",
        "parent_schema_datasource_mapping": { "40": "213", "134": "386" },
        "computed_parent_schema_datasource_mapping": { "40": "213", "134": "386" },
        "hierarchy_level": "Level 2"
      }
    ]
  }
}

GET

api

customers

curl --location --request GET 'https://api.explo.co/v2/api/customers/?pageSize=2&page=1' \
--header 'Content-Type: application/json' \
--header 'Explo-Authorization: Token <token>'

{
  "total_count": 10,
  "results": {
    "customers": [
      {
        "token": "<customer_token_to_auth_dashboard>",
        "name": "Example 1",
        "provided_id": "example_1",
        "is_demo_group": false,
        "emails": ["[email protected]"],
        "group_tags": ["designers", "engineers"],
        "properties": { "filter_value": "value" },
        "computed_properties": { "filter_value": "value" },
        "access_group": "Development",
        "parent_schema_datasource_mapping": { "40": "213", "134": "386" },
        "computed_parent_schema_datasource_mapping": { "40": "213", "134": "386" },
        "hierarchy_level": "Level 1"
      },
      {
        "token": "<customer_token_to_auth_dashboard>",
        "name": "Example 2",
        "provided_id": "example_2",
        "is_demo_group": false,
        "emails": ["[email protected]"],
        "group_tags": [],
        "properties": { "filter_value": "value" },
        "computed_properties": { "filter_value": "value" },
        "access_group": "Production",
        "parent_schema_datasource_mapping": { "40": "213", "134": "386" },
        "computed_parent_schema_datasource_mapping": { "40": "213", "134": "386" },
        "hierarchy_level": "Level 2"
      }
    ]
  }
}

This endpoint gets all of your customers. This list will be filtered to the customers your API token has access to.

parent_provided_id

string

Filters customers to those with specified parent provided id.

hierarchy_level_name

string

Filters customers to those within the specified hierarchy level.

page

number

The result page number to request. Defaults to 1.

page_size

number

The result page size. Defaults to 20. The max is 1000

Response

total_count

number

The total number of results possible.

results

object

Response wrapper object. Contains the customers response field.

customers

object[]

The contents of each customer

Show Toggle object

token

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.

name

string

The display name you provided for your customer in Explo.

provided_id

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.

emails

object

An array of email addresses you provided for your customer.

group_tags

object

An array of group tag names that have been assigned to this customer.

hierarchy_level

string

The name of the assigned hierarchy level.

access_group

string or null

If present, the name of the assigned data visibility group.

is_demo_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.

properties

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.

computed_properties

JSON

A properties object based on the provided properties of this customer and any inherited properties from parent customers.

parent_schema_datasource_mapping

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.

computed_parent_schema_datasource_mapping

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 GET 'https://api.explo.co/v2/api/customers/?pageSize=2&page=1' \
--header 'Content-Type: application/json' \
--header 'Explo-Authorization: Token <token>'

{
  "total_count": 10,
  "results": {
    "customers": [
      {
        "token": "<customer_token_to_auth_dashboard>",
        "name": "Example 1",
        "provided_id": "example_1",
        "is_demo_group": false,
        "emails": ["[email protected]"],
        "group_tags": ["designers", "engineers"],
        "properties": { "filter_value": "value" },
        "computed_properties": { "filter_value": "value" },
        "access_group": "Development",
        "parent_schema_datasource_mapping": { "40": "213", "134": "386" },
        "computed_parent_schema_datasource_mapping": { "40": "213", "134": "386" },
        "hierarchy_level": "Level 1"
      },
      {
        "token": "<customer_token_to_auth_dashboard>",
        "name": "Example 2",
        "provided_id": "example_2",
        "is_demo_group": false,
        "emails": ["[email protected]"],
        "group_tags": [],
        "properties": { "filter_value": "value" },
        "computed_properties": { "filter_value": "value" },
        "access_group": "Production",
        "parent_schema_datasource_mapping": { "40": "213", "134": "386" },
        "computed_parent_schema_datasource_mapping": { "40": "213", "134": "386" },
        "hierarchy_level": "Level 2"
      }
    ]
  }
}

Customer Endpoints [Deprecated] Get All (v1)

API Documentation

Customer API

Resource API

Partners API

Group Tag API

End User API [Deprecated]

End User Group API [Deprecated]

Get all customers (v2)

Response

API Documentation

Customer API

Resource API

Partners API

Group Tag API

End User API [Deprecated]

End User Group API [Deprecated]

​Response

Response