Explo
Search…
End User Group API
post
https://embeddo.herokuapp.com/
embed/create_user_group/
Get or Create User Group
Response field descriptions
Field Name
Type
Description
success
number
Indicates whether the call was successful. 1 if successful, 0 if not.
new_user_group
boolean
Indicates whether a new user group was created.
user_group.team_id
number
This is Explo's internal ID for this user group. You don't need to record this information, since you will not need to use it.
user_group.token
string
This is the user group token (userGroupToken or USER_GROUP_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.
user_group.name
string
This is the name of the user group provided in the request body.
user_group.provided_id
string
This is the user_group_id provided in the request body.

Example Request

1
curl --location --request POST 'https://embeddo.herokuapp.com/embed/create_user_group/' \
2
--header 'Content-Type: application/json' \
3
--header 'Explo-Authorization: Token <token>' \
4
--data-raw '{
5
"user_group_id": "example_1",
6
"name": "Example 1"
7
"mapping": {"40": "213", "134": "386"}
8
}'
Copied!
post
https://embeddo.herokuapp.com/
embed/update_user_group/
Update User Group
Response field descriptions
Field Name
Type
Description
success
number
Indicates whether the call was successful. 1 if successful, 0 if not.
user_group.team_id
boolean
Indicates whether a new user group was created.
user_group.token
string
This is the user group token (userGroupToken or USER_GROUP_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.
user_group.name
string
This is the new name of the user group provided in the request body.
user_group.provided_id
string
This is the user_group_id provided in the request body.
Example Request
1
curl --location --request POST 'https://embeddo.herokuapp.com/embed/update_user_group/' \
2
--header 'Content-Type: application/json' \
3
--header 'Explo-Authorization: Token <token>' \
4
--data-raw '{
5
"user_group_id": "example_1",
6
"name": "Example 1"
7
"mapping": {"40": "213", "134": "386"}
8
}'
Copied!
post
https://embeddo.herokuapp.com/
embed/refresh_user_group_token/
Refresh User Group Token
Response field descriptions
Field Name
Type
Description
success
number
Indicates whether the call was successful. 1 if successful, 0 if not.
user_group.team_id
number
This is Explo's internal ID for this user group. You don't need to record this information, since you will not need to use it.
user_group.token
string
This is the user group token (userGroupToken or USER_GROUP_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.
user_group.name
string
This is the name of the user group provided in the request body.
user_group.provided_id
string
This is the user_group_id provided in the request body.

Example Request

1
curl --location --request POST 'https://embeddo.herokuapp.com/embed/refresh_user_group_token/' \
2
--header 'Content-Type: application/json' \
3
--header 'Explo-Authorization: Token <token>' \
4
--data-raw '{
5
"current_token": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
6
}'
Copied!
delete
https://embeddo.herokuapp.com/
embed/delete_user_group/
Delete User Group
Response field descriptions
Field Name
Type
Description
success
number
Indicates whether the call was successful. 1 if successful, 0 if not.

Example Request

1
curl --location --request DELETE 'https://embeddo.herokuapp.com/embed/delete_user_group/' \
2
--header 'Content-Type: application/json' \
3
--header 'Explo-Authorization: Token <token>' \
4
--data-raw '{
5
"user_group_id": "example_1"
6
"current_token": "abcdef"
7
}'
Copied!
Last modified 2mo ago