Explo | Customer-facing analytics for any platform

curl --location --request POST 'https://api.explo.co/api/update_user_group/' \
--header 'Content-Type: application/json' \
--header 'Explo-Authorization: Token <token>' \
--data-raw '{
    "user_group_id": "example_1",
    "name": "Example 1",
    "mapping": {"40": "213", "134": "386"},
    "properties": {"filterValue": "value"}
}'

{
  "success": 1,
  "user_group": {
    "team_id": 113,
    "token": "<customer_token_to_auth_dashboard>",
    "name": "Example 1",
    "provided_id": "example_1",
    "is_demo_group": false
  }
}

POST

api

update_user_group

curl --location --request POST 'https://api.explo.co/api/update_user_group/' \
--header 'Content-Type: application/json' \
--header 'Explo-Authorization: Token <token>' \
--data-raw '{
    "user_group_id": "example_1",
    "name": "Example 1",
    "mapping": {"40": "213", "134": "386"},
    "properties": {"filterValue": "value"}
}'

{
  "success": 1,
  "user_group": {
    "team_id": 113,
    "token": "<customer_token_to_auth_dashboard>",
    "name": "Example 1",
    "provided_id": "example_1",
    "is_demo_group": false
  }
}

The End User Group API is now deprecated and has been replaced by the Customer API. Each End User Group entity corresponds to a Customer entity, with its user_group_id corresponding to a Customer customer_id.This API method has been replaced by Update Customer.

This endpoint updates an existing user group.

Body

string

This is the name of the user group.

string

This is the ID you use to identify this user group in your database.

object

This is a JSON mapping of schema id to either the data source that this user group should be associated with or id of the datasource you provided when creating it.

boolean

Set this boolean parameter to true to make data panels include a demo watermark for the user group. Demo user groups do not count towards paid user groups. Default value is false.

object

This is a JSON object for properties assigned to this user group. These will be accessible through variables in the dashboards and SQL editor

Response

number

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

object

The contents of the user group

Show Toggle object

number

Indicates whether a new user group was created.

string

This is the user group token (customerToken or CUSTOMER_TOKEN) that will be used to identify which user group is viewing the dashboard. You should save this on your end to use when rendering an embedded dashboard.

string

This is the name of the user group provided in the request body.

string

This is the user_group_id provided in the request body.

boolean

If set to true, data panels displayed for the user group will include a demo watermark.

JSON | Null

This is the properties object if it was provided in the request body

JSON or null

This is the environment tag of the user group. Possible values are ‘Customer’ and ‘Testing’

curl --location --request POST 'https://api.explo.co/api/update_user_group/' \
--header 'Content-Type: application/json' \
--header 'Explo-Authorization: Token <token>' \
--data-raw '{
    "user_group_id": "example_1",
    "name": "Example 1",
    "mapping": {"40": "213", "134": "386"},
    "properties": {"filterValue": "value"}
}'

{
  "success": 1,
  "user_group": {
    "team_id": 113,
    "token": "<customer_token_to_auth_dashboard>",
    "name": "Example 1",
    "provided_id": "example_1",
    "is_demo_group": false
  }
}

API Documentation

Customer API

Resource API

Partners API

Group Tag API

End User API [Deprecated]

End User Group API [Deprecated]

Update User Group

Body

Response

​Body

​Response

Body

Response