Welcome to the Preset API Collection.
\nThe Preset REST API is a powerful feature that provides access to core functional aspects of both Preset Manager and Superset.
\nThe API supports the following areas of Preset:
\nUser and Team Management
\nWorkspace Management
\nConnection and Data Management
\nVisualization Management
\nPermissions Management [Beta]
\nThis documentation lists the most relevant endpoints across all of the above functional areas of Preset.
\nTo generate an API key, from the Preset Manager screen (after log-in), hover your cursor over the initials icon and, in the sub-menu, select Manage User Settings.
\n![](\"https://i.ibb.co/D1xHc92/api1.png\")
\n\nIn the API Keys section, select + Generate New API Key
\n![](\"https://i.ibb.co/LRWp7HC/api2.png\")
\n\nThe Generate a New API Key panel appears.
\nIn the Key Title field, enter a name for the new API key.
\nIn the Key Description field, enter a brief descripton of the API key.
\nSelect Submit.
\n![](\"https://i.ibb.co/cC0H4mY/api3.png\")
\n\nThe Token field will automatically populate with a generated token.
\nLikewise, the Secret field will automatically populate with a secret.
\n![](\"https://i.ibb.co/8smp5pZ/api5.png\")
\n\nReminder: Safeguard the Secret**Please take a moment to select the Copy icon and then safely store it.
\nWhen ready, select OK.
\n![](\"https://i.ibb.co/LdNDGNp/api6.png\")
\n\nThe newly-created API key appears in the API Keys section.
\nBy default, the API key will be activated — to deactivate, toggle the Active slider to the off position.
\nTo delete an API key, select the trash bin icon.
\nAll requests on this collection inherit the token specified on the Preset API collection.
\nTo authenticate:
\nClick on the Preset API Collection.
\nNavigate to the Variables tab.
\nProvide your API Token on the APITokenName current value.
Provide the API Token Secret on the APITokenSecret current value.
These would be used to generate a JWT Token that's stored as a Global Variable.
\nThere's a script defined on this collection, that is always executed before any request. The script basically checks if there's a valid JWT Token and tries to generate one/refresh it if needed.
\nUse the Get a JWT Token request to generate a JWT Token.
To interact with the Preset API, it's required to generate an API Key, that's used to generate a JWT token.
\ntoken and secret.Replace in the body:
\n{{APIToken}} with the token from the UI.{{APISecret}} with the secret from the UI.API to authenticate and get a JWT token to interact with the Preset/Superset APIs.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"897820f6-4ee1-4b86-a1c4-679506a6103d"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"41684e8f-e7d8-4f6e-abf0-eeef524f4ce1"}}],"_postman_id":"66547093-7a32-425e-943e-1dcb103f40ce"},{"name":"Preset Manager APIs","item":[{"name":"Teams","item":[{"name":"Get Preset Teams","event":[{"listen":"prerequest","script":{"id":"a1d55dca-ab60-43e2-9d70-5da16f0886ff","exec":[""],"type":"text/javascript"}}],"id":"14c77840-3bf5-49f7-8c3d-0dcb372c7637","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://api.app.preset.io/v1/teams/","description":"Retrieves all Preset teams the user has access to.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JWTToken}}"}]},"isInherited":true,"source":{"_postman_id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","name":"Preset API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","teams",""],"host":["api","app","preset","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"14c77840-3bf5-49f7-8c3d-0dcb372c7637"},{"name":"Get Team Members","id":"24d1aeef-574b-4871-84a7-75bb021daffe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.app.preset.io/v1/teams/{{TeamSlug}}/memberships","description":"Gets all members of the Team.
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.Gets all pending team invitations.
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.Gets all regions available for a Team.
\nThis is useful for Teams with Managed Private Cloud (MPC) deployment(s), as they can create Workpsaces in all regular SaaS regions + MPC regions.
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.Creates a team invitation, sent via email.
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.Replace in the Body:
\n{{RoleID}} with the desired role:
Use 2 for User.
Use 1 for Admin.
{{Email}} with the user's email address.
When triggering the invitation, you can also specify a Workspace Role to be applied to this user in certain Workspaces. To do so, replace:
\n{{WorkspaceID}} with the id retrieved through the API with the Get Workspaces from a Team endpoint. Multiple Workspace IDs can be added to the workspace_ids array (comma separated).
{{RoleIdentifier}} with the desired option:
Each role identifier corresponds to a specific Workspace Role. As a reminder, the access restrictions for each Workspace Role can be found in our documentation.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JWTToken}}"}]},"isInherited":true,"source":{"_postman_id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","name":"Preset API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","teams","{{TeamSlug}}","invites"],"host":["api","app","preset","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"626fea46-31a8-4e3c-8b36-9fb5090aa116"},{"name":"Create Multiple Team Invites","id":"604a6578-17c2-4900-ae8b-c32b3615482b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"invites\": [\r\n {\r\n \"team_role_id\": {{RoleID}},\r\n \"email\": \"{{Email}}\",\r\n \"workspace_ids\": [ //optional\r\n {{WorkspaceID}}\r\n ],\r\n \"workspace_role_identifier\": \"{{WorkspaceRole}}\" //optional\r\n },\r\n {\r\n \"team_role_id\": {{RoleID}},\r\n \"email\": \"{{Email2}}\",\r\n \"workspace_ids\": [ //optional\r\n {{WorkspaceID}}\r\n ],\r\n \"workspace_role_identifier\": \"{{WorkspaceRole}}\" //optional\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.app.preset.io/v1/teams/{{TeamSlug}}/invites/many","description":"Creates multiple team invitations.
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.Replace in the body:
\n{{RoleID}} with the desired role:
Use 2 for User.
Use 1 for Admin.
{{Email}}, {{Email2}}... with the users' email addresses.
You can also specify a Workspace Role to be applied to each user in certain Workspaces. To do so, replace:
\n{{WorkspaceID}} with the id retrieved through the API with the Get Workspaces from a Team endpoint. Multiple Workspace IDs can be added to the workspace_ids array (comma separated).
{{RoleIdentifier}} with the desired option:
Each role identifier corresponds to a specific Workspace Role. As a reminder, the access restrictions for each Workspace Role can be found in our documentation.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JWTToken}}"}]},"isInherited":true,"source":{"_postman_id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","name":"Preset API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","teams","{{TeamSlug}}","invites","many"],"host":["api","app","preset","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"604a6578-17c2-4900-ae8b-c32b3615482b"},{"name":"Resend Invite","id":"5f84cecd-17d8-4d25-891c-3e67bd7f552b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.app.preset.io/v1/teams/{{TeamSlug}}/invites/resend/{{InviteID}}","description":"Resends a pending Team invitation.
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members
{{InviteID}}with the id retrieved through the API using the Get Pending Team Invites endpoint.
Updates the Team title.
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.Replace in the Body:
\n{{NewTeamTitle}} by the new title you want to set.Changes a user's Team role.
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.{{UserID}}with the id retrieved using the Get Team Members endpoint.Replace in the Body:
\n{{RoleID}} with the desired role:2 for User.1 for Admin.Deletes a Team member.
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.{{UserID}}with the id retrieved using the Get Team Members endpoint.Deletes a Team invitation.
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.
{{InviteID}}with the id retrieved through the API using the Get Pending Team Invites endpoint.
APIs to manage your Preset team.
\n","_postman_id":"cf3f7d6c-5f1e-4826-be13-43ce1a8088bf","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JWTToken}}"}]},"isInherited":true,"source":{"_postman_id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","name":"Preset API","type":"collection"}}},{"name":"Workspaces","item":[{"name":"Get Workspaces from a Team","id":"13611012-94e1-4581-8724-6889e110d4b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.app.preset.io/v1/teams/{{TeamSlug}}/workspaces","description":"Gets all Workspaces from the Team.
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.Gets a specific Workspace from the Team.
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.
{{WorkspaceID}} with the id retrieved through the API with the Get Workspaces from a Team endpoint.
Gets Users and their Workspace Roles from the Workspace.
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.
{{WorkspaceID}} with the id retrieved through the API with the Get Workspaces from a Team endpoint.
Gets all Embedded Authentication token keys associated with a Workspace.
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
Creates a new Workspace on the Team in a SaaS region.
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.Replace in the Body:
\n{{NewWorkspaceTitle}} by the title of the New Workspace you want to create.
{{NewWorkspaceDescription}} with a description for this Workspace.
{{NewWorkspaceColor}} with the desired color to be used by the Workspace tile. Available options:
D0ABFF
FF9797
8CBAFF
FFE895
92D0BA
A0A0A0
{{NewWorkspaceRegion}} with the region that the Workspace should be created - refer to below table:
{{NewWorkspaceIcon}} with the desired icon for the Workspace. Available options:
four-o-clock
crescent-moon
high-voltage
recycle
airplane
desktop-computer
hourglass
rocket
alembic
diamond-dot
house
round-pushpin
anchor
direct-hit
key
scales
articulated-lorry
electric-light-bulb
lady-beetle
shield
automobile-car
electric-plug
leaf-fluttering
ship
banknote-dollar-sign
envelope
mobile-phone
shopping-trolley
bar-chart
evergreen-tree
music-note
snowflake
beer
factory
office-building
studio-microphone
bell
floppy-disk
package
telescope
birthday-cake
gear
page-facing-up
tram
black-square
gem-stone
paperclip
trophy
bomb
globe-meridians
paw-prints
victory-hand
briefcase
headphone
public-address-loudspeaker
vulcan-salute
broken-heart
heart
pushpin
world-map
chart-upwards
heavy-dollar-sign
racing-motorcycle
{{LoadExamples}} with true to inclue example assets in the Workspace, or false to create an empty Workspace.
Creates a new Workspace on the Team in an MPC region.
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.Replace in the Body:
\n{{NewWorkspaceTitle}} by the title of the New Workspace you want to create.
{{NewWorkspaceDescription}} with a description for this Workspace.
{{NewWorkspaceColor}} with the desired color to be used by the Workspace tile. Available options:
D0ABFF
FF9797
8CBAFF
FFE895
92D0BA
A0A0A0
{{MPCClusterID}} with the cluster_id retrieved through the API from the Get Team Regions endpoint.
{{NewWorkspaceIcon}} with the desired icon for the Workspace. Available options:
four-o-clock
crescent-moon
high-voltage
recycle
airplane
desktop-computer
hourglass
rocket
alembic
diamond-dot
house
round-pushpin
anchor
direct-hit
key
scales
articulated-lorry
electric-light-bulb
lady-beetle
shield
automobile-car
electric-plug
leaf-fluttering
ship
banknote-dollar-sign
envelope
mobile-phone
shopping-trolley
bar-chart
evergreen-tree
music-note
snowflake
beer
factory
office-building
studio-microphone
bell
floppy-disk
package
telescope
birthday-cake
gear
page-facing-up
tram
black-square
gem-stone
paperclip
trophy
bomb
globe-meridians
paw-prints
victory-hand
briefcase
headphone
public-address-loudspeaker
vulcan-salute
broken-heart
heart
pushpin
world-map
chart-upwards
heavy-dollar-sign
racing-motorcycle
{{LoadExamples}} with true to inclue example assets in the Workspace, or false to create an empty Workspace.
Creates an Embedded Authentication token key.
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
Replace in the body:
\n{{PublicKey}} with your PEM-encoded public key. It should begin with -----BEGIN PUBLIC KEY----- and end with -----END PUBLIC KEY-----. Ensure no spaces or headers are included outside the encapsulation boundaries. The key must be provided in a single, continuous block of text and should be at least 2048 bits long.Updates an existing Workspace from the team.
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.
{{WorkspaceID}} with the id retrieved through the API with the Get Workspaces from a Team endpoint.
Replace in the Body:
\n{{NewWorkspaceTitle}} with the new title for the Workspace.
{{NewWorkspaceDescription}} with the new description for this Workspace.
{{NewWorkspaceColor}} with the desired color to be used by the Workspace tile. Available options:
D0ABFF
FF9797
8CBAFF
FFE895
92D0BA
A0A0A0
{{NewWorkspaceIcon}} with the desired icon for the Workspace. Available options:
four-o-clock
crescent-moon
high-voltage
recycle
airplane
desktop-computer
hourglass
rocket
alembic
diamond-dot
house
round-pushpin
anchor
direct-hit
key
scales
articulated-lorry
electric-light-bulb
lady-beetle
shield
automobile-car
electric-plug
leaf-fluttering
ship
banknote-dollar-sign
envelope
mobile-phone
shopping-trolley
bar-chart
evergreen-tree
music-note
snowflake
beer
factory
office-building
studio-microphone
bell
floppy-disk
package
telescope
birthday-cake
gear
page-facing-up
tram
black-square
gem-stone
paperclip
trophy
bomb
globe-meridians
paw-prints
victory-hand
briefcase
headphone
public-address-loudspeaker
vulcan-salute
broken-heart
heart
pushpin
world-map
chart-upwards
heavy-dollar-sign
racing-motorcycle
Changes a user's Workspace Role.
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.
{{WorkspaceID}} with the id retrieved through the API with the Get Workspaces from a Team endpoint.
Replace in the body:
\n{{UserID}}with the id retrieved using the Get Team Members endpoint.
{{RoleIdentifier}}with one of the the role_identifier below, wrapped in double quotes:
Each Role Identifier corresponds to a specific Workspace Role. As a reminder, the access restrictions for each Workspace Role can be found in our documentation.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JWTToken}}"}]},"isInherited":true,"source":{"_postman_id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","name":"Preset API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","teams","{{TeamSlug}}","workspaces","{{WorkspaceID}}","membership"],"host":["api","app","preset","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"03e6a219-1898-489f-b62c-73a34ef3ba3d"},{"name":"Delete a Workspace from a Team","id":"1ad1316f-f9f5-4694-b634-5efa9686aa38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.app.preset.io/v1/teams/{{TeamSlug}}/workspaces/{{WorkspaceID}}","description":"Deletes a specific Workspace from the Team.
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.
{{WorkspaceID}} with the id retrieved through the API with the Get Workspaces from a Team endpoint.
Deletes an Embedded Authentication token key.
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{KeyID}} with the id for the key that should be deleted retrieved through the API (using the Get all Embedded Authentication Keys endpoint).
APIs to manage your Workspaces.
\n","_postman_id":"e837ece3-056b-4807-8003-e37ed396566c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JWTToken}}"}]},"isInherited":true,"source":{"_postman_id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","name":"Preset API","type":"collection"}}},{"name":"Permissions","item":[{"name":"Get Resources","id":"03770644-28f8-4f6b-a327-749792bdc272","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.app.preset.io/v1/teams/{{TeamSlug}}/permissions/resources","description":"List all resources from a team.
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.Note that the query parameters are optional and very useful to retrieve the desired data:
\nworkspace_name can be used to filter for permissions only applied to a particular Workspace.resource_type can be used to filter for:database to list databasesdatabase_schema to list schemasdatasource to list DAR permission reference of a dataset (not the dataset itself)dataset to list datasetsdata_access_role to list DARsrow_level_security to list RLSs(optional) Use the name retrieved through the API (using the Get Workspaces from a Team endpoint).
\n","type":"text/plain"},"key":"workspace_name","value":"{{WorkspaceSlug}}"},{"disabled":true,"description":{"content":"(optional) Filter for the different types:
\ndatabasedatabase_schemadatasource (DAR permission reference of a dataset, not the dataset itself.)datasetquery (query to a database, e.g. all_query_access).data_access_rolerow_level_securityList all permissions from a team.
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.Note that the query parameters are optional and very useful to retrieve the desired data:
\nworkspace_name can be used to filter for permissions only applied to a particular Workspace.permission_type can be used to filter for only data_access_role, or row_level_security.grantee_identifier can be used to filter for all permissions included in a DAR (dar:{{DAR NAME}}), or all permissions applied to a user (username).(optional) Use the name retrieved through the API (using the Get Workspaces from a Team endpoint).
\n","type":"text/plain"},"key":"workspace_name","value":"{{WorkspaceSlug}}"},{"disabled":true,"description":{"content":"(optional) Filter for type:
\ndata_access_rolerow_level_security(optional) Filter for user or DAR:
\nusername of a user if grantee is userdar:{{DARName}} if grantee is roleCreates a new Data Access Role (DAR).
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.Replace in the body:
\n{{GranteeType}}by USER if the Grantee is already a member of the workspace, or INVITEE if that member's invitation to join the workspace is pending
{{Username}} by the username of the user if he is already a member of the workspace. You can get a list of usernames with the Get Team Members API endpoint. If this user hasn't accepted the invite yet, you can use the email the invite was sent to.
{{DARName}} by the name you want to give your DAR
{{ResourceName}} by the name of the resource you want your DAR to have acces to. You can see all resources with the Get Resources endpoint.
{{GrantAction}} by the permission action given by the grant. Available options:
database_accessschema_accessdatasource_accessall_database_accessall_datasource_accessall_query_access{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
Please note:
\nCreates a Row Level Security (RLS).
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.Replace in the body:
\n{{DARName1}} with the DAR name you want to associated with this RLS (also for {{DARName2}} and so on). You can get a list of availabe DARs using the Get Permissions endpoint. Note that you would use the display name (without dar:).
{{RLSName}} with the name of your RLS.
{{RLSClause}} with the SQL syntax for the filter to be applied.
{{RLSFilterType}} with Regular or Base.
{{RLSGroupKey}} with the desired group key.
{{ResourceName}} with the datasource name. You can get a list of available options using the Get Resources endpoint (filtering for &resource_type=dataset).
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
Please note:
\nAdds Grantee(s) to an existing Permission (DAR or RLS).
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.{{PermissionName}} with the name retrieved via the Get Permissions API.Replace in the body:
\n{{GranteeType}} with:USER to add existing user to DARs.INVITEE to add pending user to DARsROLE to add DAR to RLS.{{GranteeIdentifier}} with:username when adding users to DAR. You can get a list of usernames with the Get Team Members API. For pending users you can use their email.DAR Name when adding DAR to RLS. You can get a list of availabe DARs using the Get Permissions endpoint. Note that you would use the display name (without dar:).Please note:
\nUpdates an existing Data Access Role (DAR).
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.{{PermissionName}} with the name retrieved via the Get Permissions API.Note that the payload has to be complete - you can't remove the grantees. If you just want to add a new user, use the Add Grantees to existing Permission endpoint.
Replace in the body:
\n{{GranteeType}}by USER if the Grantee is already a member of the workspace, or INVITEE if that member's invitation to join the workspace is pending
{{Username}} by the username of the user if he is already a member of the workspace. You can get a list of usernames with the Get Team Members API endpoint. If this user hasn't accepted the invite yet, you can use the email the invite was sent to.
{{DARName}} by the name you want to give your DAR.
{{ResourceName}} by the name of the resource you want your DAR to have acces to. You can see all resources with the Get Resources endpoint.
{{GrantAction}} by the permission action given by the grant. Available options:
database_accessschema_accessdatasource_accessall_database_accessall_datasource_accessall_query_access{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
Please note:
\nUpdates an existing Row Level Security (RLS).
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.{{PermissionName}} with the name retrieved via the Get Permissions API.Note that the payload has to be complete - you can't remove the grantees.
Replace in the body:
\n{{DARName1}} with the DAR name you want to associated with this RLS (also for {{DARName2}} and so on). You can get a list of availabe DARs using the Get Permissions endpoint. Note that you would use the display name (without dar:).{{RLSName}} with the name of your RLS.{{RLSClause}} with the SQL syntax for the filter to be applied.{{RLSFilterType}} with Regular or Base.{{RLSGroupKey}} with the desired group key.{{ResourceName}} with the datasource name. You can get a list of available options using the Get Resources endpoint (filtering for &resource_type=dataset).{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).Please note:
\nDeletes a Data Access Role (DAR).
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.{{PermissionName}} with the name retrieved via the Get Permissions API.Deletes a Row Level Security (RLS).
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.{{PermissionName}} with the name retrieved via the Get Permissions API.Removes Grantee(s) from an existing Permission (DAR or RLS).
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.{{PermissionName}} with the name retrieved via the Get Permissions API.Replace in the body:
\n{{GranteeType}} with:USER to add users to DARs.ROLE to add DAR to RLS.{{GranteeIdentifier}} with:username when adding users to DAR. You can get a list of usernames with the Get Team Members API.DAR Name when adding DAR to RLS. You can get a list of availabe DARs using the Get Permissions endpoint. Note that you would use the display name (without dar:).APIs to manage permissions on the Workspace level.
\nNote that all Permission APIs require Team Admin permission.
\n","_postman_id":"1d87dbae-8aef-4c4e-bfdd-fc9a70984bef","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JWTToken}}"}]},"isInherited":true,"source":{"_postman_id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","name":"Preset API","type":"collection"}}},{"name":"Embedded","item":[{"name":"Get Embedded Configuration for a Dashboard","id":"97a85017-2a09-45be-8de4-f374c3de03cc","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-length":true}},"request":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Referer","value":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/api/v1/dashboard/{{DashboardID}}/embedded","description":"Retrieves the Embedded configuration for a Dashboard using the API.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{DashboardID}} with the id of the desired Dashboard. You can get the id using the Get all Dashboards From a Workspace endpoint. Alternatively, you can get it from the Dashboard URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/dashboard/{{DashboardID}}.Generates a Guest Token.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
For details on how to update the body, please refer to our documentation.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JWTToken}}"}]},"isInherited":true,"source":{"_postman_id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","name":"Preset API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","teams","{{TeamSlug}}","workspaces","{{WorkspaceSlug}}","guest-token",""],"host":["api","app","preset","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"b1a9877e-958d-4957-8939-a6d0d3f10e70"},{"name":"Enable Embedded for a Dashboard","id":"2fc1cefc-bb4d-4635-a2d1-c04147b6007a","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-length":true}},"request":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Referer","value":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/","type":"text"}],"body":{"mode":"raw","raw":" {\n \t\"allowed_domains\": [\n \"{{AllowedDomain}}\"\n ]\n }","options":{"raw":{"language":"json"}}},"url":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/api/v1/dashboard/{{DashboardID}}/embedded","description":"Enables Embedded mode for a Dashboard using the API.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{DashboardID}} with the id of the desired Dashboard. You can get the id using the Get all Dashboards From a Workspace endpoint. Alternatively, you can get it from the Dashboard URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/dashboard/{{DashboardID}}.Replace in the body:
\n{{AllowedDomain}} with the domain that should be allowed to embed this dashboard. Make sure to include the protocol( https://...). Multiple values can be added and should be separated with a comma. Alternatively, use an empty array to allow embedding on any domain:{\n \"allowed_domains\": []\n}\n\nUpdates the Embedded Configuration for a Dashboard using the API.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{DashboardID}} with the id of the desired Dashboard. You can get the id using the Get all Dashboards From a Workspace endpoint. Alternatively, you can get it from the Dashboard URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/dashboard/{{DashboardID}}.Replace in the body:
\n{{AllowedDomain}} with the domain that should be allowed to embed this dashboard. Make sure to include the protocol( https://...). Multiple values can be added and should be separated with a comma. Alternatively, use an empty array to allow embedding on any domain:{\n \"allowed_domains\": []\n}\n\nDisables the Embedded configuration for a Dashboard using the API.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{DashboardID}} with the id of the desired Dashboard. You can get the id using the Get all Dashboards From a Workspace endpoint. Alternatively, you can get it from the Dashboard URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/dashboard/{{DashboardID}}.APIs associated with the Embedded functionality.
\n","_postman_id":"97235b90-321b-4446-a5f7-f43681650691","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JWTToken}}"}]},"isInherited":true,"source":{"_postman_id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","name":"Preset API","type":"collection"}}},{"name":"Audit Logs","item":[{"name":"Query Audit Logs","id":"a9efe9c2-b665-4f74-8b8c-4b5dda0b9397","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.app.preset.io/v2/audit/teams/{{TeamSlug}}/logs","description":"Queries the Preset Team's Audit Logs records.
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.Note that the query parameters are optional and very useful to filter for the desired data:
\nentity_type can be used to filter for logs associated with a particular entity type. Available options:urn:preset:auditlogurn:preset:userurn:preset:ws:charturn:preset:ws:dashboardurn:preset:ws:databaseurn:preset:ws:datasetentity_id can be used to filter for the unique entity ID (for example, chart ID, dashboard ID, etc).entity_name can be used to filter using the friendly name of entity.action can be used to filter for specific actions. Use the action_urn values retrieved from the Get Available Actions API endpoint.user can be used to filter for actions performed by a particular user. Either the username or email can be used.start_time and end_time can be used to filter by the period. The expected format is YYYY-MM-DD HH:MM:SS.mm (for example 2023-08-01 00:00:01.00).workspace_name can be used to filter by actions related to a specific Workspace. Use the name retrieved through the API (using the Get Workspaces from a Team endpoint).page_number to paginate results. Default/start value is 1.page_size to set a maximum page size. Default/max value is 100.order_by and direction to specify the column to be used in the sorting logic, and direction (either asc or desc).(optional) Filter by the type of entity.
\n","type":"text/plain"},"key":"entity_type","value":"{{EntityType}}"},{"disabled":true,"description":{"content":"(optional) Filter by the entity ID.
\n","type":"text/plain"},"key":"entity_id","value":"{{EntityID}}"},{"disabled":true,"description":{"content":"(optional) Filter by the entity's friendly name.
\n","type":"text/plain"},"key":"entity_name","value":"{{EntityName}}"},{"disabled":true,"description":{"content":"(optional) Filter by the action performed.
\n","type":"text/plain"},"key":"action","value":"{{ActionURN}}"},{"disabled":true,"description":{"content":"(optional) Filter by the actor. Accepts either the username or email.
\n","type":"text/plain"},"key":"user","value":"{{UsernameOREmail}}"},{"disabled":true,"description":{"content":"(optional) Filter by start time.
\n","type":"text/plain"},"key":"start_time","value":"{{StartTime}}"},{"disabled":true,"description":{"content":"(optional) Filter by the end time.
\n","type":"text/plain"},"key":"end_time","value":"{{EndTime}}"},{"disabled":true,"description":{"content":"(optional) Filter by the Workspace Slug.
\n","type":"text/plain"},"key":"workspace_name","value":"{{WorkspaceSlug}}"},{"disabled":true,"description":{"content":"(optional) Control the page number for pagination. Starts at 1.
\n","type":"text/plain"},"key":"page_number","value":"{{PageNumber}}"},{"disabled":true,"description":{"content":"(optional) Control the page size. Maximum allowed value (and default) is 100.
\n","type":"text/plain"},"key":"page_size","value":"{{PageSize}}"},{"disabled":true,"description":{"content":"(optional) Control the column to order results.
\n","type":"text/plain"},"key":"order_by","value":"{{OrderColumn}}"},{"disabled":true,"description":{"content":"(optional) Control the sorting option.
\n","type":"text/plain"},"key":"direction","value":"{{SortOption}}"}],"variable":[]}},"response":[],"_postman_id":"a9efe9c2-b665-4f74-8b8c-4b5dda0b9397"},{"name":"Get Available Actions","id":"0ad58e8d-3b0d-40e4-af0d-441778433965","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.app.preset.io/v2/audit/teams/{{TeamSlug}}/logs/actions","description":"Queries the actions logged on the Audit Logs records.
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.Downloads the Preset Team's Audit Log records.
\nReplace in the URL:
\n{{TeamSlug}} with the name retrieved through the API (using the Get Preset Teams endpoint). Alternatively, access the team administration through the UI, and get the {{TeamSlug}} from the URL -> https://manage.app.preset.io/app/teams/{{TeamSlug}}/members.The via_email parameter in the body is required and should be set to false so that the report is returned in the API response.
The remaining information in the body is optional and very useful to filter for the desired data:
\nentity_type can be used to filter for logs associated with a particular entity type. Available options:
urn:preset:auditlog
urn:preset:user
urn:preset:ws:chart
urn:preset:ws:dashboard
urn:preset:ws:database
urn:preset:ws:dataset
entity_id can be used to filter for the unique entity ID (for example, chart ID, dashboard ID, etc).
entity_name can be used to filter using the friendly name of entity.
action can be used to filter for specific actions. Use the action_urn values retrieved from the Get Available Actions API endpoint.
user can be used to filter for actions performed by a particular user. Either the username or email can be used.
start_time and end_time can be used to filter by the period. The expected format is YYYY-MM-DD HH:MM:SS.mm (for example 2023-08-01 00:00:01.00).
workspace_name can be used to filter by actions related to a specific Workspace. Use the name retrieved through the API (using the Get Workspaces from a Team endpoint).
page_number to paginate results. Default/start value is 1.
page_size to set a maximum page size. Default/max value is 100.
order_by and direction to specify the column to be used in the sorting logic, and direction (either asc or desc).
APIs to retrieve Audit Logs.
\nNote that these APIs require Team Admin permission.
\n","_postman_id":"734eab62-92dd-4f43-b0ad-841376ec00bc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JWTToken}}"}]},"isInherited":true,"source":{"_postman_id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","name":"Preset API","type":"collection"}}}],"id":"d50afb5c-85fd-4251-be6e-c69e8a41c079","description":"Use Preset Manager APIs to manage your Team, Workspaces, Embedded configurations and also Permissions.
\n","_postman_id":"d50afb5c-85fd-4251-be6e-c69e8a41c079","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JWTToken}}"}]},"isInherited":true,"source":{"_postman_id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","name":"Preset API","type":"collection"}}},{"name":"Superset APIs (Open Source)","item":[{"name":"Alerts & Reports","item":[{"name":"Get all Alerts and Reports from a Workspace","id":"a98af76a-0b62-405c-8855-86a91f1f1440","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/api/v1/report/","description":"Gets all Alerts & Reports created on the Workspace.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
Note that this endpoint returns 20 results by default. You can return up to 100 results at a time and use pagination by adding the following query parameters:
\n?q=(page_size:{{PageSize}},page:{{Page}})\n\nReplace:
\n{{PageSize}} with the desired size (min 1 max 100).
{{Page}} with the page number (useful when the total count > {{PageSize}} - min 0).
(optional) Used to control pagination and page size (max page size = 100).
\n","type":"text/plain"},"key":"q","value":"(page:0,page_size:100)"}],"variable":[]}},"response":[],"_postman_id":"a98af76a-0b62-405c-8855-86a91f1f1440"},{"name":"Get all Alerts from a Workspace","id":"057e67c5-29fd-4a41-a095-2394770da9a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/api/v1/report/?q=(filters:!((col:type,opr:eq,value:Alert)),page_size:100,page:0)","description":"Gets all Alerts created on the Workspace.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
Note that the response includes a count value, indicating the total count of Alerts. 100 alerts would be included on the response - if count > 100, you can access the remaining items by increasing the page value on the q parameter:
?q=(filters:!((col:type,opr:eq,value:Alert)),page_size:{{PageSize}},page:{{Page}})\n\nUsed to filter results to include only Alerts.\nPagination and page size are also controlled by this parameter (max page size = 100).
Gets all Reports created on the Workspace.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
Note that the response includes a count value, indicating the total count of Alerts. 100 alerts would be included on the response - if count > 100, you can access the remaining items by increasing the page value on the q parameter:
?q=(filters:!((col:type,opr:eq,value:Report)),page_size:{{PageSize}},page:{{Page}})\n\nUsed to filter results to include only Reports.\nPagination and page size are also controlled by this parameter (max page size = 100).
Gets a specific Alert/Report from the Workspace.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{AlertID OR ReportID}} with the id retrieved from one of the endpoints below:
Get all Alerts and Reports from a Workspace
\nGet all Alerts from a Workspace
\nGet all Reports from a Workspace
\nGets metadata information about the Alerts & Reports API endpoints.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
Gets all Slack Channel IDs from the connected Slack Workspace.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
Creates a Chart Report on the Workspace through the API.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
Replace in the body:
\n{{ActiveBooleanFlag}} with:
true to create it enabled.
\nfalse to create it disabled.
\n{{ReportName}} with a name for your report.
{{ChartID}} with the id of the desired Chart, retrieved using the Get all Charts from a Workspace endpoint.
{{ReportDescription}} with a description for it.
{{CRONSchedule}} with the desired frequency (in cron).
{{Timezone}} with the desired timezone. The list of valid options can be retrieved using the Get Alerts & Reports API metadata Info endpoint.
{{ForceBooleanFlag}} with:
true to ignore cache.
\nfalse to use cache if available.
\n{{ReportFormat}} with either CSV, PNG, or TEXT (TEXT can only be used with Table Charts).
For the owners field:
Replace {{OwnerID}} with the owner's account ID on the Workspace level (you can retrieve this ID using the Get all possible Chart Owners endpoint).
This field is an array, so multiple owners can be added, separated by comma.
\nFor the recipients field:
Replace {{ReportType}} with Email or SlackV2.
{{TargetInfo}} with the email address/Slack channel ID.
This field is an array, so multiple recipient configuration can be added (comma separated).
\n{{CustomWidth}} (optional) can be used to set the screenshot width in pixels.
{{LogRetention}} with the retention period (in days). Default and max value is 90.
{{WorkingTimeout}} with time out settings (in seconds). Default value is 3600.
{{GracePeriod}} with a grace period (in seconds). Default value is 14400.
Creates a Dashboard Report on the Workspace through the API.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
Replace in the body:
\n{{ActiveBooleanFlag}} with:
true to create it enabled.
\nfalse to create it disabled.
\n{{ReportName}} with a name for your report.
{{DashboardID}} with the id of the desired Dashboard, retrieved using the Get all Dashboards from a Workspace endpoint.
{{ReportDescription}} with a description for it.
{{CRONSchedule}} with the desired frequency (in cron).
{{Timezone}} with the desired timezone. The list of valid options can be retrieved using the Get Alerts & Reports API metadata Info endpoint.
{{ForceBooleanFlag}} with:
true to ignore cache.
\nfalse to use cache if available.
\nFor the owners field:
Replace {{OwnerID}} with the owner's account ID on the Workspace level (you can retrieve this ID using the Get all possible Chart Owners endpoint).
This field is an array, so multiple owners can be added, separated by comma.
\nFor the recipients field:
Replace {{ReportType}} with Email or SlackV2.
{{TargetInfo}} with the email address/Slack channel ID.
This field is an array, so multiple recipient configuration can be added (comma separated).
\n{{CustomWidth}} (optional) can be used to set the screenshot width in pixels.
{{LogRetention}} with the retention period (in days). Default and max value is 90.
{{WorkingTimeout}} with time out settings (in seconds). Default value is 3600.
{{GracePeriod}} with a grace period (in seconds). Default value is 14400.
Creates a Chart Alert on the Workspace through the API.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
Replace in the body:
\n{{ActiveBooleanFlag}} with:
true to create it enabled.
\nfalse to create it disabled.
\n{{AlertName}} with a name for your alert.
{{ChartID}} with the id of the desired Chart, retrieved using the Get all Charts from a Workspace endpoint.
{{AlertDescription}} with a description for it.
{{CRONSchedule}} with the desired frequency (in cron).
{{Timezone}} with the desired timezone. The list of valid options can be retrieved using the Get Alerts & Reports API metadata Info endpoint.
{{ForceBooleanFlag}} with:
true to ignore cache.
\nfalse to use cache if available.
\n{{AlertFormat}} with either CSV, PNG, or TEXT (TEXT can only be used with Table Charts).
{{DatabaseID}} with the id of the database that should be used to execute the SQL validation. You can retrieve this id using the Get all Database Connections from a Workspace endpoint.
{{SQLCondition}} with the SQL query that should be validated by the alert. Note that the SQL query should return only one column, for example select count(\\\\\\\\\\\\\\\\\\*) from {{MyTable}}.
{{ValidatorType}} with:
operator when performing number comparisson.
not null to check if the SQL result is not null. When using not null, the validator_config_json should be empty:
\"validator_type\": \"not null\",\n\"validator_config_json\": {}\n\n{{Operator}} with the operation that should be used to analyze the SQL result. Available options:
== to check if SQL result is equal the threshold value.
< to check if the SQL result is smaller than the t
the threshold value.
\n> to check if the SQL result is larger than the the threshold value.
<= to check if the SQL result is not larger than the the threshold value.
>= to check if the SQL result is not smaller than the the threshold value.
!= to check if the SQL result is different than the threshold value.
{{Threshold}} with the condition value.
For the owners field:
Replace {{OwnerID}} with the owner's account ID on the Workspace level (you can retrieve this ID using the Get all possible Chart Owners endpoint).
This field is an array, so multiple owners can be added, separated by comma.
\nFor the recipients field:
Replace {{AlertType}} with Email or SlackV2.
{{TargetInfo}} with the email address/Slack channel ID.
This field is an array, so multiple recipient configuration can be added (comma separated).
\n{{CustomWidth}} (optional) can be used to set the screenshot width in pixels.
{{LogRetention}} with the retention period (in days). Default and max value is 90.
{{WorkingTimeout}} with time out settings (in seconds). Default value is 3600.
{{GracePeriod}} with a grace period (in seconds). Default value is 14400.
Creates a Dashboard Alert on the Workspace through the API.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
Replace in the body:
\n{{ActiveBooleanFlag}} with:
true to create it enabled.
\nfalse to create it disabled.
\n{{AlertName}} with a name for your alert.
{{DashboardID}} with the id of the desired Dashboard, retrieved using the Get all Dashboards from a Workspace endpoint.
{{AlertDescription}} with a description for it.
{{CRONSchedule}} with the desired frequency (in cron).
{{Timezone}} with the desired timezone. The list of valid options can be retrieved using the Get Alerts & Reports API metadata Info endpoint.
{{ForceBooleanFlag}} with:
true to ignore cache.
\nfalse to use cache if available.
\n{{DatabaseID}} with the id of the database that should be used to execute the SQL validation. You can retrieve this id using the Get all Database Connections from a Workspace endpoint.
{{SQLCondition}} with the SQL query that should be validated by the alert. Note that the SQL query should return only one column, for example select count(\\\\\\\\\\\\\\\\\\\\*) from {{MyTable}}.
{{ValidatorType}} with:
operator when performing number comparisson.
not null to check if the SQL result is not null. When using not null, the validator_config_json should be empty:
\"validator_type\": \"not null\",\n\"validator_config_json\": {}\n\n{{Operator}} with the operation that should be used to analyze the SQL result. Available options:
== to check if SQL result is equal the threshold value.
< to check if the SQL result is smaller than the t
the threshold value.
\n> to check if the SQL result is larger than the the threshold value.
<= to check if the SQL result is not larger than the the threshold value.
>= to check if the SQL result is not smaller than the the threshold value.
!= to check if the SQL result is different than the threshold value.
{{Threshold}} with the condition value.
For the owners field:
Replace {{OwnerID}} with the owner's account ID on the Workspace level (you can retrieve this ID using the Get all possible Chart Owners endpoint).
This field is an array, so multiple owners can be added, separated by comma.
\nFor the recipients field:
Replace {{AlertType}} with Email or SlackV2.
{{TargetInfo}} with the email address/Slack channel ID.
This field is an array, so multiple recipient configuration can be added (comma separated).
\n{{CustomWidth}} (optional) can be used to set the screenshot width in pixels.
{{LogRetention}} with the retention period (in days). Default and max value is 90.
{{WorkingTimeout}} with time out settings (in seconds). Default value is 3600.
{{GracePeriod}} with a grace period (in seconds). Default value is 14400.
Updates an specific Alert/Report from the Workspace.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{AlertID OR ReportID}} with the id retrieved from one of the endpoints below:Update the body accordingly, keeping only the fields that should be updated. Refer to the Create a Chart Report, Create a Dashboard Report, Create a Chart Alert and Create a Dashboard Alert endpoints documentation for further details on how to configure each field.
\nSome examples:
\nactive in the payload set to true (to enable it) or false (to disable it).crontab in the payload with the new CRON schedule configuration string.Deletes an Alert/Report from the Workspace.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{AlertID OR ReportID}} with the id retrieved from one of the endpoints below:
Get all Alerts and Reports from a Workspace
\nGet all Alerts from a Workspace
\nGet all Reports from a Workspace
\nAPIs to manage your Alerts & Reports.
\n","_postman_id":"da0097a4-3a74-4c6b-bfb8-4c398b405754","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JWTToken}}"}]},"isInherited":true,"source":{"_postman_id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","name":"Preset API","type":"collection"}}},{"name":"Annotation Layers","item":[{"name":"Get all Annotation Layers from a Workspace","id":"28db89e9-9246-400d-8a5a-90c56b6a58ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/api/v1/annotation_layer/","description":"Gets all Annotation Layers from a Workspace.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
Note that this endpoint returns 20 results by default. You can return up to 100 results at a time and use pagination by adding the following query parameters:
\n?q=(page_size:{{PageSize}},page:{{Page}})\n\nReplace:
\n{{PageSize}} with the desired size (min 1 max 100).
{{Page}} with the page number (useful when the total count > {{PageSize}} - min 0).
(optional) Used to control pagination and page size (max page size = 100).
\n","type":"text/plain"},"key":"q","value":"(page:0,page_size:100)"}],"variable":[]}},"response":[],"_postman_id":"28db89e9-9246-400d-8a5a-90c56b6a58ee"},{"name":"Get an Annotation Layer","id":"64fa7cb9-999c-44fb-b92e-b0211c1b3a1e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/api/v1/annotation_layer/{{AnnotationLayerID}}","description":"Gets a specific Annotation Layer from a Workspace.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{AnnotationLayerID}} with the Annotation Layer id retrieved from the Get all Annotation Layers from a Workspace endpoint.Gets all Annotations from a specific Annotation Layer.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{AnnotationLayerID}} with the Annotation Layer id retrieved from the Get All Annotation Layers from a Workspace endpoint.Note that this endpoint returns 20 results by default. You can return up to 100 results at a time and use pagination by adding the following query parameters:
\n?q=(page_size:{{PageSize}},page:{{Page}})\n\nReplace:
\n{{PageSize}} with the desired size (min 1 max 100).
{{Page}} with the page number (useful when the total count > {{PageSize}} - min 0).
(optional) Used to control pagination and page size (max page size = 100).
\n","type":"text/plain"},"key":"q","value":"(page:0,page_size:100)"}],"variable":[]}},"response":[],"_postman_id":"f2216349-ea9e-4313-a75b-18a4343f3634"},{"name":"Get an Annotation from an Annotation Layer","id":"886fffc4-5489-4f69-bc83-1627cc5912dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Referer","value":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/","type":"text"}],"url":"{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/api/v1/annotation_layer/{{AnnotationLayerID}}/annotation/{{AnnotationID}}","description":"Deletes an Annotation Layer through the API.
\nNote: You can only delete an Annotation Layer, after deleting all its Annotations.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{AnnotationLayerID}} with the Annotation Layer id retrieved from the Get all Annotation Layers from a Workspace endpoint.
{{AnnotationID}} with the Annotation id retrieved from the Get all Annotations from an Annotation Layer endpoint.
Creates an Annotation Layer through the API.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
Replace in the body:
\n{{AnnotationLayerDescription}} with a description for the Annotation Layer.
{{AnnotationLayerName}} with the desired new name.
Creates an Annotation on an existing Annotation Layer through the API.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{AnnotationLayerID}} with the Annotation Layer id retrieved from the Get all Annotation Layers from a Workspace endpoint.Replace in the body:
\n{{AnnotationEndDTTM}} with the annotation's datetime end (YYYY-MM-DD HH:MM).
{{AnnotationLongDescription}} with the annotation's description.
{{AnnotationShortDescription}} with a name for it.
{{AnnotationStartDTTM}} with the annotation's datetime start (YYYY-MM-DD HH:MM).
Updates an Annotation Layer through the API.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{AnnotationLayerID}} with the Annotation Layer id retrieved from the Get all Annotation Layers from a Workspace endpoint.Replace in the body:
\n{{AnnotationLayerDescription}} with a description for the Annotation Layer.
{{AnnotationLayerName}} with the desired new name.
Updates an Annotation from an Annotation Layer through the API.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{AnnotationLayerID}} with the Annotation Layer id retrieved from the Get all Annotation Layers from a Workspace endpoint.
{{AnnotationLayerID}} with the Annotation Layer id retrieved from the Get all Annotation Layers from a Workspace endpoint.
Replace in the body:
\n{{AnnotationEndDTTM}} with the annotation's datetime end (YYYY-MM-DD HH:MM).
{{AnnotationLongDescription}} with the annotation's description.
{{AnnotationShortDescription}} with a name for it.
{{AnnotationStartDTTM}} with the annotation's datetime start (YYYY-MM-DD HH:MM).
Deletes an Annotation from an Annotation Layer through the API.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{AnnotationLayerID}} with the Annotation Layer id retrieved from the Get all Annotation Layers from a Workspace endpoint.
{{AnnotationID}} with the Annotation id retrieved from the Get all Annotations from an Annotation Layer endpoint.
Deletes multiple Annotations from an Annotation Layer through the API.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{AnnotationLayerID}} with the Annotation Layer id retrieved from the Get all Annotation Layers from a Workspace endpoint.
{{AnnotationIDs} with comma separated Annotation ids retrieved from the Get all Annotations from an Annotation Layer endpoint.
Comma separated list of Annotation IDs.
\n","type":"text/plain"},"key":"q","value":"!({{AnnotationIDs}})"}],"variable":[]}},"response":[],"_postman_id":"aabf1763-0432-4717-b689-5539170ac9fa"},{"name":"Delete an Annotation Layer","id":"fa945412-3450-4b14-a6ea-6825721e68f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Referer","value":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/","type":"text"}],"url":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/api/v1/annotation_layer/{{AnnotationLayerID}}","description":"Deletes an Annotation Layer through the API.
\nNote: You can only delete an Annotation Layer, after deleting all its Annotations.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{AnnotationLayerID}} with the Annotation Layer id retrieved from the Get all Annotation Layers from a Workspace endpoint.Deletes multiple Annotations from an Annotation Layer through the API.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{AnnotationLayerID}} with the Annotation Layer id retrieved from the Get all Annotation Layers from a Workspace endpoint.
{{AnnotationLayerIDs} with comma separated Annotation Layer ids retrieved from the Get all Annotation Layers from a Workspace endpoint.
Comma separated list of Annotation Layer IDs.
\n","type":"text/plain"},"key":"q","value":"!({{AnnotationLayerIDs}})"}],"variable":[]}},"response":[],"_postman_id":"8a2d28b6-de25-4e5f-b35c-bb79ded00672"}],"id":"a40b2025-0356-4e0d-80b2-bef5129c7542","description":"API to manage your Annotation Layers.
\n","_postman_id":"a40b2025-0356-4e0d-80b2-bef5129c7542","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JWTToken}}"}]},"isInherited":true,"source":{"_postman_id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","name":"Preset API","type":"collection"}}},{"name":"Assets","item":[{"name":"Export Assets","id":"9d360d4d-e009-4044-989c-9ee41eceedaf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/zip","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/api/v1/assets/export/","description":"Generates and export a ZIP file from the Workspace containing all:
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
Tip: If used in Postman, select Save Response and Save to a File to get the zip export.
Imports an assets ZIP file.
Replace in the URL and in the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
Replace in the body:
\n{{DatabaseYAMLFile}} by the database YAML File you can find in your chart export under the folder Databases.
{{DatabasePassword}} by your database password
Chose your Chart Export Zip file as a value for the formData.
APIs to export/import an assets ZIP file from the Workspace, which includes all:
Gets all Charts from a Workspace.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
Note that this endpoint returns 20 results by default. You can return up to 100 results at a time and use pagination by adding the following query parameters:
\n?q=(page_size:{{PageSize}},page:{{Page}})\n\nReplace:
\n{{PageSize}} with the desired size (min 1 max 100).
{{Page}} with the page number (useful when the total count > {{PageSize}} - min 0).
(optional) Used to control pagination and page size (max page size = 100).
\n","type":"text/plain"},"key":"q","value":"(page:0,page_size:100)"}],"variable":[]}},"response":[],"_postman_id":"8160eb8e-d278-447a-9edc-7f0b3491052d"},{"name":"Get a Chart","id":"7c1a023a-0947-40b7-8ef5-4a1b4a15a85f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/api/v1/chart/{{ChartID}}","description":"Gets a specific Chart from a Workspace.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{ChartID}} with the chart id retrieved from theGets Chart's data from a Workspace.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{ChartID}} with the chart id retrieved from the Get all Charts from a Workspace endpoint.Gets all possible Chart owners on the Workspace.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
Note that this endpoint returns 20 results by default. You can return up to 100 results at a time and use pagination by adding the following query parameters:
\n?q=(page_size:{{PageSize}},page:{{Page}})\n\nReplace:
\n{{PageSize}} with the desired size (min 1 max 100).
{{Page}} with the page number (useful when the total count > {{PageSize}} - min 0).
(optional) Used to control pagination and page size (max page size = 100).
\n","type":"text/plain"},"key":"q","value":"(page:0,page_size:100)"}],"variable":[]}},"response":[],"_postman_id":"24da5a04-8cd4-441f-beb6-43bc29a9a978"},{"name":"Generate a Chart Screenshot","id":"00765aca-a0c9-410f-8b5c-74eafac325f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/api/v1/chart/{{ChartID}}/cache_screenshot/","description":"Generates a chart screenshot.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{ChartID}} with the id retrieved from the Get all Charts from a Workspace endpoint.A force query parameter can be used to force refresh the data before taking the screenshot.
The screenshot generation is processed in async mode. The API response includes a task_status and a task_updated_at timestamp that can be used to track progress, along with the image_url that can be used to download the file. Possible task_status values:
Pending: screenshot is awaiting to be processed.
Computing: screenshot job has been picked up by the Celery worker and is being processed.
Updated: screenshot has been processed and is available at the image_url.
Error: an error occurred while processing the task.
(optional) Refresh the screenshot (Bypass cache)
\n","type":"text/plain"},"key":"q","value":"(force:!t)"}],"variable":[]}},"response":[],"_postman_id":"00765aca-a0c9-410f-8b5c-74eafac325f5"},{"name":"Export Charts","id":"79610421-0808-4e7d-9471-080f3799b419","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"default"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/zip","type":"text"},{"key":"Referer","value":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/","type":"text"}],"url":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/api/v1/chart/export/?q=!({{ChartIDs}})","description":"Exports Charts.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{ChartIDs} with comma separated chart ids retrieved from the Get all Charts from a Workspace endpoint.Tip: If used in Postman, select Save Response and Save to a File to get the zip export.
Comma separated list of Chart IDs.
\n","type":"text/plain"},"key":"q","value":"!({{ChartIDs}})"}],"variable":[]}},"response":[],"_postman_id":"79610421-0808-4e7d-9471-080f3799b419"},{"name":"Create a Chart","id":"255a2b50-9c33-464d-95a9-5f859a617548","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Referer","value":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/","type":"text"}],"body":{"mode":"raw","raw":"{\n \"cache_timeout\": null,\n \"certification_details\": null,\n \"certified_by\": null,\n \"dashboards\": [8],\n \"description\": null,\n \"is_managed_externally\": false,\n \"owners\": [],\n \"params\": \"{\\\"adhoc_filters\\\": [], \\\"color_scheme\\\": \\\"supersetColors\\\", \\\"datasource\\\": \\\"21__table\\\", \\\"granularity_sqla\\\": \\\"year\\\", \\\"groupby\\\": [\\\"platform\\\"], \\\"label_colors\\\": {\\\"2600\\\": \\\"#D1C6BC\\\", \\\"3DO\\\": \\\"#A38F79\\\", \\\"3DS\\\": \\\"#B2B2B2\\\", \\\"Action\\\": \\\"#ACE1C4\\\", \\\"Adventure\\\": \\\"#5AC189\\\", \\\"COUNT(*)\\\": \\\"#1FA8C9\\\", \\\"DC\\\": \\\"#666666\\\", \\\"DS\\\": \\\"#E04355\\\", \\\"Fighting\\\": \\\"#D1C6BC\\\", \\\"GB\\\": \\\"#A1A6BD\\\", \\\"GBA\\\": \\\"#A868B7\\\", \\\"GC\\\": \\\"#D3B3DA\\\", \\\"GEN\\\": \\\"#FF7F44\\\", \\\"GG\\\": \\\"#8FD3E4\\\", \\\"Microsoft Game Studios\\\": \\\"#FCC700\\\", \\\"Misc\\\": \\\"#D3B3DA\\\", \\\"N64\\\": \\\"#EFA1AA\\\", \\\"NES\\\": \\\"#FEC0A1\\\", \\\"NG\\\": \\\"#FCC700\\\", \\\"Nintendo\\\": \\\"#666666\\\", \\\"PC\\\": \\\"#8FD3E4\\\", \\\"PCFX\\\": \\\"#A1A6BD\\\", \\\"PS\\\": \\\"#FCC700\\\", \\\"PS2\\\": \\\"#454E7C\\\", \\\"PS3\\\": \\\"#FF7F44\\\", \\\"PS4\\\": \\\"#A38F79\\\", \\\"PSP\\\": \\\"#3CCCCB\\\", \\\"PSV\\\": \\\"#454E7C\\\", \\\"Platform\\\": \\\"#FDE380\\\", \\\"Puzzle\\\": \\\"#454E7C\\\", \\\"Racing\\\": \\\"#9EE5E5\\\", \\\"Role-Playing\\\": \\\"#EFA1AA\\\", \\\"SAT\\\": \\\"#5AC189\\\", \\\"SCD\\\": \\\"#E04355\\\", \\\"SNES\\\": \\\"#FDE380\\\", \\\"Shooter\\\": \\\"#B2B2B2\\\", \\\"Simulation\\\": \\\"#1FA8C9\\\", \\\"Sports\\\": \\\"#FEC0A1\\\", \\\"Strategy\\\": \\\"#FF7F44\\\", \\\"TG16\\\": \\\"#3CCCCB\\\", \\\"Take-Two Interactive\\\": \\\"#E04355\\\", \\\"WS\\\": \\\"#A868B7\\\", \\\"Wii\\\": \\\"#666666\\\", \\\"WiiU\\\": \\\"#1FA8C9\\\", \\\"X360\\\": \\\"#5AC189\\\", \\\"XB\\\": \\\"#ACE1C4\\\", \\\"XOne\\\": \\\"#9EE5E5\\\"}, \\\"metrics\\\": [\\\"count\\\"], \\\"number_format\\\": \\\"SMART_NUMBER\\\", \\\"queryFields\\\": {\\\"groupby\\\": \\\"groupby\\\", \\\"metrics\\\": \\\"metrics\\\"}, \\\"row_limit\\\": 10, \\\"slice_id\\\": 661, \\\"time_range\\\": \\\"No filter\\\", \\\"time_range_endpoints\\\": [\\\"inclusive\\\", \\\"exclusive\\\"], \\\"treemap_ratio\\\": 1.618033988749895, \\\"url_params\\\": {}, \\\"viz_type\\\": \\\"treemap\\\"}\",\n \"query_context\": null,\n \"slice_name\": \"Test API Created Chart 2\",\n \"viz_type\": \"treemap\",\n \"datasource_id\": 2,\n \"datasource_type\": \"table\"\n }","options":{"raw":{"language":"json"}}},"url":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/api/v1/chart","description":"Creates a Chart through the API.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
Replace in the body:
\ncache_timeout (optional) by the chart timeout in seconds.
certification_details (optional) by the details of certification.
certified_by (optional) by the certifier.
dashboards by a comma separated list (csl) of dashboard ids the chart should be added to (can be empty).
description (optional) by your description.
is_managed_externally by true or false.
owners by a csl of owner ids.
params by a string of all parameters need to define your chart. You can get an example of this either by checking the network tab by creating a chart in the UI or by calling the Get a Chart endpoint.
slice_name by the name you want to give to your chart.
viz_type by the visualization type. You can find this with the Get a Chart endpoint for a similar chart.
datasource_id by the id of the dataset powering your chart.
datasource_type by the type of the underlying dataset.
Refreshes the Chart data.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{ChartID}} with the id retrieved from the Get all Charts from a Workspace endpoint.The body payload can vary depending on the visualization type used and also the chart configuration, The easiest way to get the accurate payload is retrieving the query_context data from the Get a Chart endpoint, and then set force to true both in the top level and also inside form_data.
ID of the Chart to be refreshed.
\n","type":"text/plain"},"key":"slice_id","value":"{{ChartID}}"},{"description":{"content":"Flag to force refresh data.
\n","type":"text/plain"},"key":"force","value":"true "}],"variable":[]}},"response":[],"_postman_id":"dae775c3-dbb7-4966-a553-daac3ef76abd"},{"name":"Import a Chart","id":"8acb3b9c-ff0d-4342-88a7-1bc665ba0726","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Content-Type header generated by Postman.","key":"Content-Type","value":"multipart/form-data;","type":"text"},{"key":"Referer","value":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"formData","type":"file","value":null},{"key":"passwords","value":"{\"databases/{{DatabaseYAMLFile}}\": \"{{DatabasePassword}}\"}","type":"text"},{"key":"overwrite","value":"true","type":"text"}]},"url":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/api/v1/chart/import/","description":"Imports a Chart via the API.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
In the body:
\nSelect your Chart ZIP file as a value for the formData.
For the passwords field:
If the Database used by the Chart doesn't exist on the destination Workspace yet:
\nReplace {{DatabaseYAMLFile}} by the database YAML file name. You can find it in your Chart export file, under the databases folder.
Replace {{DatabasePassword}} by your DB password.
If the Database already exists on the destination Workspace, you can remove this field from the body.
\nFor the overwrite field:
If the Chart already exists on the destination Workspace, set it as true to overwrite it.
If the Chart doesn't exist in there yet, you can remove this field from the body.
\nUpdates a Chart via the API.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{ChartID}} with the chart id retrieved from theReplace in the body:
\ncache_timeout (optional) by the chart timeout in seconds.
certification_details (optional) by the details of certification.
certified_by (optional) by the certifier.
dashboards by a comma separated list (csl) of dashboard ids the chart should be added to (can be empty).
description (optional) by your description.
is_managed_externally by true or false.
owners by a csl of owner ids.
params by a string of all parameters need to define your chart. You can get an example of this either by checking the network tab by creating a chart in the UI or by calling the Get a Chart endpoint.
slice_name by the name you want to give to your chart.
viz_type by the visualization type. You can find this with the Get a Chart endpoint for a similar chart.
datasource_id by the id of the dataset powering your chart.
datasource_type by the type of the underlying dataset.
Deletes a Chart.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{ChartID}} with the chart id retrieved from the Get all Charts from a Workspace endpoint.APIs to manage Charts on your Workspace.
\n","_postman_id":"9c6a7dab-b3ec-44c8-b3a1-50411b66fa7a","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JWTToken}}"}]},"isInherited":true,"source":{"_postman_id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","name":"Preset API","type":"collection"}}},{"name":"Dashboards","item":[{"name":"Get all Dashboards From a Workspace","id":"2787cb4e-39e9-4b99-92e0-86282bc5794a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/api/v1/dashboard/","description":"Gets all Dashboards from a Workspace.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
Note that this endpoint returns 20 results by default. You can return up to 100 results at a time and use pagination by adding the following query parameters:
\n?q=(page_size:{{PageSize}},page:{{Page}})\n\nReplace:
\n{{PageSize}} with the desired size (min 1 max 100).
{{Page}} with the page number (useful when the total count > {{PageSize}} - min 0).
(optional) Used to control pagination and page size (max page size = 100).
\n","type":"text/plain"},"key":"q","value":"(page:0,page_size:100)"}],"variable":[]}},"response":[],"_postman_id":"2787cb4e-39e9-4b99-92e0-86282bc5794a"},{"name":"Get a Dashboard","id":"f5e5c6d2-5f38-40bd-8c6f-9cf581eb799a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/api/v1/dashboard/{{DashboardID}}","description":"Get a specific Dashboard from a Workspace.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{DashboardID}} with the id of the desired Dashboard. You can get the id using the Get all Dashboards From a Workspace endpoint. Alternatively, you can get from the Dashboard URL -> https://{{WorkspaceSlug}}.{{Region}}.preset.io/superset/dashboard/{{DashboardID}}.Gets all Charts associated with a Dashboard.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.preset.io/superset/welcome/.
{{DashboardID}} with the ids of the desired Dashboard. You can get the ids using the Get all Dashboards From a Workspace endpoint. Alternatively, you can get from the Dashboard URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/dashboard/{{DashboardID}}.Note that this endpoint returns 20 results by default. You can return up to 100 results at a time and use pagination by adding the following query parameters:
\n?q=(page_size:{{PageSize}},page:{{Page}})\n\nReplace:
\n{{PageSize}} with the desired size (min 1 max 100).
{{Page}} with the page number (useful when the total count > {{PageSize}} - min 0).
(optional) Used to control pagination and page size (max page size = 100).
\n","type":"text/plain"},"key":"q","value":"(page:0,page_size:100)"}],"variable":[]}},"response":[],"_postman_id":"e0f31782-5037-404f-938f-40e0f7bd6a43"},{"name":"Get Datasets from a Dashboard","id":"ede8fafd-44d0-4784-b4bc-bb8d11fcc120","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/api/v1/dashboard/{{DashboardID}}/datasets","description":"Gets all Datasets associated with a Dashboard.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.preset.io/superset/welcome/.
{{DashboardID}} with the ids of the desired Dashboard. You can get the ids using the Get all Dashboards From a Workspace endpoint. Alternatively, you can get from the Dashboard URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/dashboard/{{DashboardID}}.Note that this endpoint returns 20 results by default. You can return up to 100 results at a time and use pagination by adding the following query parameters:
\n?q=(page_size:{{PageSize}},page:{{Page}})\n\nReplace:
\n{{PageSize}} with the desired size (min 1 max 100).
{{Page}} with the page number (useful when the total count > {{PageSize}} - min 0).
(optional) Used to control pagination and page size (max page size = 100).
\n","type":"text/plain"},"key":"q","value":"(page:0,page_size:100)"}],"variable":[]}},"response":[],"_postman_id":"ede8fafd-44d0-4784-b4bc-bb8d11fcc120"},{"name":"Get all possible Dashboard Owners","id":"913e410d-7973-444b-a5c6-6ed9e1a7fdb5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/api/v1/dashboard/related/owners","description":"Gets all possible Dashboard owners on the Workspace.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
Note that this endpoint returns 20 results by default. You can return up to 100 results at a time and use pagination by adding the following query parameters:
\n?q=(page_size:{{PageSize}},page:{{Page}})\n\nReplace:
\n{{PageSize}} with the desired size (min 1 max 100).{{Page}} with the page number (useful when the total count > {{PageSize}} - min 0).(optional) Used to control pagination and page size (max page size = 100).
\n","type":"text/plain"},"key":"q","value":"(page:0,page_size:100)"}],"variable":[]}},"response":[],"_postman_id":"913e410d-7973-444b-a5c6-6ed9e1a7fdb5"},{"name":"Export Dashboards","id":"83164c24-7448-47df-8a68-6cbc61a2671f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/zip","type":"text"}],"url":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/api/v1/dashboard/export/?q=!({{DashboardIDs}})","description":"Exports a ZIP file from a Dashboard.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{DashboardIDs}} with the ids of the Dashboard(s) you want to export (separated by comma). You can get the ids using the Get all Dashboards From a Workspace endpoint. Alternatively, you can get from the Dashboard URL -> https://{{WorkspaceSlug}}.{{Region}}.preset.io/superset/dashboard/{{DashboardID}}.Tip: If used in Postman, select Save Response and Save to a File to get the zip export.
Comma separated list of Dashboard IDs.
\n","type":"text/plain"},"key":"q","value":"!({{DashboardIDs}})"}],"variable":[]}},"response":[],"_postman_id":"83164c24-7448-47df-8a68-6cbc61a2671f"},{"name":"Get Embedded Configuration for a Dashboard","id":"28be17ce-6a0a-40c6-9b18-0ae9664a6570","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-length":true}},"request":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Referer","value":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/api/v1/dashboard/{{DashboardID}}/embedded","description":"Retrieves the Embedded configuration for a Dashboard using the API.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{DashboardID}} with the id of the desired Dashboard. You can get the id using the Get all Dashboards From a Workspace endpoint. Alternatively, you can get it from the Dashboard URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/dashboard/{{DashboardID}}.Gets metadata information about the Dashboard API endpoints.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
Creates a Dashboard using the API.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
Replace in the body:
\n{{CertificationDetails}} (optional) with the dashboard certification information.{{CertifiedBy}} (optional) with the information about the certifier (this is a string, and not a user/account representation).{{DashboardTitle}} with the title for the dashboard.{{JSONMetadata}} configuration in the json_metadata field, or leave it as an empty JSON.{{OwnerID}} with the user id retrieved via the Get all possible Dashboard Owners API endpoint. This is an array, so multiple IDs can be used.{{PositionJSON}} (optional) with the dashboard position configuration. If this is not specified, the default layout would be used.{{Published}} with either true or false.{{DashboardSlug}} (optional) with the dashboard slug (friendly URL).Creates a permalink to a Dashboard (with applied filters) using the API.
\nReplace in the URL and on the Referer and Origin headers:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
Replace in the body:
\n{{FilterID}} with the ID of the filter you want to modify. You can retrieve it either via the Dashboard JSON Metadata, or via the Get a Dashboard endpoint.
{{Column}} with the column that is used on the filter.
{{Operator}} with the filtering operation to be applied. Available options:
IN
NOT IN
{{Value}} with the value to be applied on the filter.
Generates a dashboard screenshot.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{DashboardID}} with the id of the desired Dashboard. You can get the id using the Get all Dashboards From a Workspace endpoint. Alternatively, you can get it from the Dashboard URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/dashboard/{{DashboardID}}.By default, an empty array can be used as the request body to get the dashboard screenshot. Alternatively, it's possible to include below fields in the body:
\ndataMask (array): Specifies the dataMask configuration (controls applied filters).
activeTabs (list): Specify the tab(s) that should be included/selected.
urlParams (list): List of URL params to be applied to the dashboard.
A force query parameter can be used to force refresh the data before taking the screenshot.
The screenshot generation is processed in async mode. The API response includes a task_status and a task_updated_at timestamp that can be used to track progress, along with the image_url that can be used to download the file. Possible task_status values:
Pending: screenshot is awaiting to be processed.
Computing: screenshot job has been picked up by the Celery worker and is being processed.
Updated: screenshot has been processed and is available at the image_url.
Error: an error occurred while processing the task.
By default, the image_url provides a PNG. To get a PDF instead, append download_format=pdf to the image_url value.
(optional) Refresh the screenshot (Bypass cache)
\n","type":"text/plain"},"key":"q","value":"(force:!t)"}],"variable":[]}},"response":[],"_postman_id":"bfe7d53d-c182-48bc-859f-a0fd5cdcb0d1"},{"name":"Import a Dashboard","id":"5589e9d4-95e5-42b9-9c33-0aa847d94a24","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Content-Type header generated by Postman.","key":"Content-Type","value":"multipart/form-data;","type":"text"},{"key":"Referer","value":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"formData","type":"file","value":null},{"key":"passwords","value":"{\"databases/{{DatabaseYAMLFile}}\": \"{{DatabasePassword}}\"}","type":"text"},{"key":"overwrite","value":"true","type":"text"}]},"url":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/api/v1/dashboard/import/","description":"Imports a Dashboard via the API.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
In the body:
\nSelect your Dashboard ZIP file as a value for the formData.
For the passwords field:
If the Database used by the Dashboard doesn't exist on the destination Workspace yet:
\nReplace {{DatabaseYAMLFile}} by the Database YAML file name. You can find it in your Dashboard export file, under the databases folder.
Replace {{DatabasePassword}} by your DB password.
If the Database already exists on the destination Workspace, you can remove this field from the body.
\nFor the overwrite field:
If the Dashboard already exists on the destination Workspace, set it as true to overwrite it.
If the Dashboard doesn't exist in there yet, you can remove this field from the body.
\nEnables Embedded mode for a Dashboard using the API.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{DashboardID}} with the id of the desired Dashboard. You can get the id using the Get all Dashboards From a Workspace endpoint. Alternatively, you can get it from the Dashboard URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/dashboard/{{DashboardID}}.Replace in the body:
\n{{AllowedDomain}} with the domain that should be allowed to embed this dashboard. Make sure to include the protocol( https://...). Multiple values can be added and should be separated with a comma. Alternatively, use an empty array to allow embedding on any domain:{\n \"allowed_domains\": []\n}\n\nUpdates a Dashboard using the API.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{DashboardID}} with the dashboard id retrieved from the Get all Dashboards from a Workspace endpoint.Only keep in the payload the fields you would like to update and the owners. Available fileds:
\n{{CertificationDetails}} (optional) with the dashboard certification information.
{{CertifiedBy}} (optional) with the information about the certifier (this is a string, and not a user/account representation).
{{DashboardTitle}} with the title for the dashboard.
You can optionally include a {{JSONMetadata}} configuration in the json_metadata field, or leave it as an empty JSON.
{{OwnerID}} with the user id retrieved via the Get all possible Dashboard Owners API endpoint. This is an array, so multiple IDs can be used.
{{PositionJSON}} (optional) with the dashboard position configuration. If this is not specified, the default layout would be used.
{{Published}} with either true or false.
{{DashboardSlug}} (optional) with the dashboard slug (friendly URL).
Updates the Embedded Configuration for a Dashboard using the API.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{DashboardID}} with the id of the desired Dashboard. You can get the id using the Get all Dashboards From a Workspace endpoint. Alternatively, you can get it from the Dashboard URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/dashboard/{{DashboardID}}.Replace in the body:
\n{{AllowedDomain}} with the domain that should be allowed to embed this dashboard. Make sure to include the protocol( https://...). Multiple values can be added and should be separated with a comma. Alternatively, use an empty array to allow embedding on any domain:{\n \"allowed_domains\": []\n}\n\nDisables the Embedded configuration for a Dashboard using the API.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{DashboardID}} with the id of the desired Dashboard. You can get the id using the Get all Dashboards From a Workspace endpoint. Alternatively, you can get it from the Dashboard URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/dashboard/{{DashboardID}}.Deletes a Dashboard.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{DashboardID}} with the id of the desired Dashboard. You can get the id using the Get all Dashboards From a Workspace endpoint. Alternatively, you can get from the Dashboard URL -> https://{{WorkspaceSlug}}.{{Region}}.preset.io/superset/dashboard/{{DashboardID}}.APIs to manage your Dashboards.
\n","_postman_id":"1be6d09f-3800-47ba-b149-0f2e09679f77","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JWTToken}}"}]},"isInherited":true,"source":{"_postman_id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","name":"Preset API","type":"collection"}}},{"name":"Databases","item":[{"name":"Get all Database Connections from a Workspace","id":"2e2f307b-fe8c-4296-9785-f9c675f79271","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/api/v1/database","description":"Gets the databases connected to your Workspace.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
Note that this endpoint returns 20 results by default. You can return up to 100 results at a time and use pagination by adding the following query parameters:
\n?q=(page_size:{{PageSize}},page:{{Page}})\n\nReplace:
\n{{PageSize}} with the desired size (min 1 max 100).{{Page}} with the page number (useful when the total count > {{PageSize}} - min 0).(optional) Used to control pagination and page size (max page size = 100).
\n","type":"text/plain"},"key":"q","value":"(page:0,page_size:100)"}],"variable":[]}},"response":[],"_postman_id":"2e2f307b-fe8c-4296-9785-f9c675f79271"},{"name":"Get a Database Connection","id":"1eca71ed-c47f-4439-9f84-14894b2662b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/api/v1/database/{{DatabaseID}}","description":"Get a specific Database Connection from a Workspace.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{DatabaseID}} with the Database Connection id retrieved from the Get All Database Connections from a Workspace endpoint.Get connection parameters from a specific Database Connection from a Workspace.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{DatabaseID}} with the Database Connection id retrieved from the Get All Database Connections from a Workspace endpoint.Exports Database Connections from the Workspace.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{DatabaseIDs} with comma separated DB ids retrieved from the Get all Database Connections from a Workspace endpoint.Tip: If used in Postman, select Save Response and Save to a File to get the zip export.
Comma separated list of database connection IDs.
\n","type":"text/plain"},"key":"q","value":"!({{DatabaseIDs}})"}],"variable":[]}},"response":[],"_postman_id":"0b8b3437-76ae-42a5-a398-9317e4d2efe7"},{"name":"Create a Database Connection","id":"ed78442d-bb5a-46cd-ae6d-915cfe95d4f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Referer","value":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"allow_ctas\": {{DBConnectionAllowCTAS}},\r\n \"allow_cvas\": {{DBConnectionAllowCVAS}},\r\n \"allow_dml\": {{DBConnectionAllowDML}},\r\n \"allow_run_async\": {{DBConnectionEnableAsyncQueries}},\r\n \"cache_timeout\": {{DBConnectionCacheTimeOut}},\r\n \"database_name\": \"{{DBConnectionName}}\",\r\n \"expose_in_sqllab\": {{DBConnectionExposeInSQLLab}},\r\n \"extra\": \"{{DBConnectionExtraConfiguration}}\",\r\n \"sqlalchemy_uri\": \"{{DBConnectionSQLAlchemyURI}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/api/v1/database","description":"Creates a new database connection in the Workspace.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
Replace on the body:
\nRequired fileds:
\n{{DBConnectionName}} with the desired DB connection display name.{{DBConnectionSQLAlchemyURI}} with the connection string to the database.Optional fields:
\nBoolean fields (use either true or false):
{{DBConnectionAllowCTAS}} to control if CREATE TABLE AS statements should be supported in SQL Lab.{{DBConnectionAllowCVAS}} to control if CREATE VIEW AS statements should be supported in SQL Lab.{{DBConnectionAllowDML}} to control if DML statements should be supported in SQL Lab (this is required to allow the previous options).{{DBConnectionEnableAsyncQueries}} to control if asynchronous query execution should be enabled for SQL Lab.{{DBConnectionExposeInSQLLab}} to control if the connection should be exposed in SQL Lab.{{DBConnectionCacheTimeOut}} with the duration (in seconds) cached results should be valid for charts powered by this connection.
{{DBConnectionExtraConfiguration}} with any addifional configuration (like Engine Parameters). For example:
{\\\"engine_params\\\": {\\\"connect_args\\\": {\\\"http_path\\\": \\\"/sql/1.0/warehouses/********\\\"}}}\n\nNote: You need to escape quotes (\") and other special characters using \\ on all body fields.
Creates a new database connection on the Workspace using SSH.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
Replace on the body:
\n{{DBConnectionName}} with the desired DB connection display name.
{{SQLAlchemyURI}} with the connection string to the database.
For the SSH configuration:
\nUse either a username and password, or username, private_key and private_key_password combination to authenticate to the SSH server, removing the un-used fields.
Replace {{SSHServerAddress}} with the SSH server host address.
boolean with either true or false to enable/disable the connection settings.
{{ExtraConfiguration}} (optional) with any addifional configuration (like Engine Parameters). For example:
{\\\"engine_params\\\": {\\\"connect_args\\\": {\\\"http_path\\\": \\\"/sql/1.0/warehouses/********\\\"}}}\n\nNote: You need to escape quotes (\") and other special characters using \\ on all body fields.
Imports a Database Connection.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
In the body:
\nSelect your Chart ZIP file as a value for the formData.
For the passwords field:
Replace {{DatabaseYAMLFile}} by the database YAML file name. You can find it in your export file, under the databases folder.
Replace {{DatabasePassword}} by the DB password.
For the overwrite field:
true to overwrite it.Updates an existing Database Connection.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{DatabaseID}} with the Database Connection id retrieved from the Get All Database Connections from a Workspace endpoint.In the body:
\nInclude the keys you would like to update. Refer to the Create a Database Connection payload to check supported values.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JWTToken}}"}]},"isInherited":true,"source":{"_postman_id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","name":"Preset API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","database","{{DatabaseID}}"],"host":["{{WorkspaceSlug}}","{{WorkspaceRegion}}","app","preset","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"dd47c54b-490b-4eed-bff3-0a83ecdda160"}],"id":"66f49969-21d5-4457-957d-0d3221db06e8","description":"APIs to manage your database connections.
\n","_postman_id":"66f49969-21d5-4457-957d-0d3221db06e8","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JWTToken}}"}]},"isInherited":true,"source":{"_postman_id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","name":"Preset API","type":"collection"}}},{"name":"Datasets","item":[{"name":"Get all Datasets","id":"0ff76fbd-6a99-43db-bb0b-055246a893e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/api/v1/dataset/","description":"Gets all Datasets from the Workspace.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
Note that this endpoint returns 20 results by default. You can return up to 100 results at a time and use pagination by adding the following query parameters:
\n?q=(page_size:{{PageSize}},page:{{Page}})\n\nReplace:
\n{{PageSize}} with the desired size (min 1 max 100).
{{Page}} with the page number (useful when the total count > {{PageSize}} - min 0).
(optional) Used to control pagination and page size (max page size = 100).
\n","type":"text/plain"},"key":"q","value":"(page:0,page_size:100)"}],"variable":[]}},"response":[],"_postman_id":"0ff76fbd-6a99-43db-bb0b-055246a893e7"},{"name":"Get a Dataset","id":"01b87de3-3d80-4512-a3e6-a804e7cb410a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/api/v1/dataset/{{DatasetID}}","description":"Get a specific Dataset from a Workspace.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{DatasetID}} with the Dataset id retrieved from the Get All Datasets from a Workspace endpoint.The include_rendered_sql query parameter is optional, and can be set to true to include Jinja syntax rendered in the response:
For virtual datasets, rendered_sql is added to the reponse to include the rendered SQL query.
rendered_expression is added to every metric and calculated column to include the rendered SQL syntax.
(optional) Controls if Jinja syntax should be rendered and included in the response
\n","type":"text/plain"},"key":"include_rendered_sql","value":"true"}],"variable":[]}},"response":[],"_postman_id":"01b87de3-3d80-4512-a3e6-a804e7cb410a"},{"name":"Get all possible Dataset Owners","id":"a0a886d9-6723-4de4-bb28-a50fe88c87a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/api/v1/dataset/related/owners","description":"Gets all possible Dataset owners on the Workspace.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
Note that this endpoint returns 20 results by default. You can return up to 100 results at a time and use pagination by adding the following query parameters:
\n?q=(page_size:{{PageSize}},page:{{Page}})\n\nReplace:
\n{{PageSize}} with the desired size (min 1 max 100).
{{Page}} with the page number (useful when the total count > {{PageSize}} - min 0).
(optional) Used to control pagination and page size (max page size = 100).
\n","type":"text/plain"},"key":"q","value":"(page:0,page_size:100)"}],"variable":[]}},"response":[],"_postman_id":"a0a886d9-6723-4de4-bb28-a50fe88c87a7"},{"name":"Export Datasets","id":"b860f738-1307-4a62-ba37-109e2dc2522d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"{{JWTToken}}","type":"text"},{"key":"Accept","value":"application/zip","type":"text"}],"url":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/api/v1/dataset/export?q=!({{DatasetIDs}})","description":"Exports Datasets from the Workspace.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{DatasetIDs}} with comma separated ids retrieved from the Get all Datasets from a Workspace endpoint.Tip: If used in Postman, select Save Response and Save to a File to get the zip export.
Comma separated list of Dataset IDs.
\n","type":"text/plain"},"key":"q","value":"!({{DatasetIDs}})"}],"variable":[]}},"response":[],"_postman_id":"b860f738-1307-4a62-ba37-109e2dc2522d"},{"name":"Create a Dataset","id":"0c8c5068-3175-4755-b533-c67c09831bea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Referer","value":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"database\": {{DBID}},\r\n \"owners\": [\r\n {{OwnerID}}\r\n ],\r\n \"schema\": \"{{SchemaName}}\",\r\n \"sql\": \"{{DatasetSQL}}\", // Only required for Virtual Datasets\r\n \"table_name\": \"{{TableName}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/api/v1/dataset","description":"Creates a new Dataset.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
Replace in the body:
\n{{DBID}} with the database id retrieved using the Get Databases endoint.
{{SchemaName}} with the desired schema.
{{TableName}} with the desired table. This should be the table name for Physical datasets, and the dataset name for Virtual Datasets.
{{OwnerID}} with the id for the desired owner account(s) retrieved from the Get all possible Dataset Owners endpoint. Use a comma to separate multiple IDs (for example, [2,5]).
{{DatasetSQL}} with the SQL query powering the dataset (only applicable to virtual datasets).
Imports a Dataset.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
In the body:
\nSelect your Dataset ZIP file as a value for the formData.
For the passwords field:
Replace {{DatabaseYAMLFile}} by the database YAML file name. You can find it in your export file, under the databases folder.
Replace {{DatabasePassword}} by the DB password.
For the overwrite field:
true to overwrite it.Updates a Dataset.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{DatasetID}} with the Dataset id retrieved from the Get All Datasets from a Workspace endpoint.Update the body accordingly, keeping only the fields that should be updated.
\nSome examples:
\nTo convert a dataset from physical to virtual, update the table_name accordingly and include a sql value. To convert a virtual dataset to physical, update the table_name to the desired table and set sql to null.
If you want to add item(s) to a list field (for example, owners, metrics, columns, etc) include the full list (existing items + new ones). If you want to remove items, provide the entire list without the item(s) to be removed.
Calculated columns are included in the columns list. The difference between a regular column and a calculated column is that the latter has the expression field populated with the corresponding SQL expression.
More details about each field:
\n{{AlwaysFilterMainDDTM}}: can be set to true / false to control if time range filters applied to non-default temporal columns should also be applied to the default one.
{{CacheTimeout}}: control the cache timeout for the dataset.
{{Catalog}}: catalog the dataset is associated with.
columns: list of {{Column}} items. Column schema details:
{{AdvancedDataType}}: can be used to indicate a custom data type for a column.
{{ColumnName}}: indicates the column name. For regular columns, correspond to an existing column in the table (for physical datasets) or SQL results (for virtual datasets). Provides a name for calculated columns. This key is always required.
{{ColumnDescription}}: column description.
{{ColumnSQLExpression}}: SQL syntax for calculated columns. Should be set to null for regular columns. This key is required for calculated columns.
{{ColumnExtra}} : stringfied JSON to define additional column metadata. Can be used to certify columns with: \"{\\\"certification\\\":{\\\"certified_by\\\":\\\"{{CertifiedBy}}\\\",\\\"details\\\":\\\"{{CertificationDetails}}\\\"}}\".
{{ColumnFilterableConfig}}: if set to false disables the column from the Filters dropdown (can still be used in filters via Custom SQL).
{{ColumnGroupByConfig}}: if set to false disables the column from the Dimensions dropdown (can still be used in dimensions via Custom SQL).
{{ColumnID}}: column ID. Should only be included for existing columns. Required for existing columns.
{{ColumnIsActive}}: set to false to deactivate the column (can still be used via Custom SQL).
{{ColumnIsDTTM}}: set to true to mark the column as temporal.
{{ColumnFormat}}: column datetime format.
{{ColumnType}}: set the column type (for example, TEXT, BIGINT, etc).
{{ColumnUUID}}: column UUID. Set a new value when creating a new column, or use an existing value when overwiriting one.
{{ColumnLabel}}: column label.
{{DBID}}: Database connection ID, retrieved from the Get all DB Connections endpoint.
{{DefaultEndpoint}}: URL to redirect users to when clicking on the dataset name from the Datasets list.
{{Description}}: dataset description.
{{ExternalURL}}: external URL to be associated with the dataset. Only exposed in the API response.
{{DatasetExtra}}: stringfied JSON to define additional dataset metadata. Can be used to certify the dataset with: \"{\\\"certification\\\":{\\\"certified_by\\\":\\\"{{CertifiedBy}}\\\",\\\"details\\\":\\\"{{CertificationDetails}}\\\"}}\".
{{FetchValuesPredicate}}: predicate SQL filter to be automatically applied in autocomplete queries.
folders: list of {{Folder}} items. Folder schema details:
name: the folder name.
uuid: the folder UUID. This is always required (use new uuid values when looking to create a new folder, or an existing UUID value when trying to update a folder).
children: list of {{Child}} objects. Child schema details:
{{ChildType}}: set to either folder (for nested folders), metric or column.
{{ChildUUID}}: for columns and metrics, use the metric/column UUID. for folders, use their UUID value (or use a new one when creating a new folder).
{{ChildName}}: should only be included for folders. Columns and metrics use their existing name.
{{IsManagedExternally}}: set to true to disable editing this dataset via the UI.
{{MainDDTMCollumn}}: name of the column to be considered the default temporal column.
metrics: list of {{Metric}} items. Metric schema details:
{{MetricCurrencySymbol}}: set the currency symbol. Possible options:JPY, USD, EUR, GBP, INR, MXN, CNY.
{{MetricCurrencySymbolPosition}}: can be set to suffix or prefix.
{{MetricD3Format}}: set metric D3 format.
{{MetricDescription}}: metric description.
{{MetricSQLExpression}}: SQL expression for the metric. This key is always required.
{{MetricExtra}}: stringfied JSON to define additional metric metadata. Can be used to certify metrics with: \"{\\\"certification\\\":{\\\"certified_by\\\":\\\"{{CertifiedBy}}\\\",\\\"details\\\":\\\"{{CertificationDetails}}\\\"}}\".
{{MetricID}}: metric ID. Should only be included for existing metrics. Required for existing metrics.
{{MetricName}}: metric name. This key is always required.
{{MetricType}}: metric type.
{{MetricUUID}}: metric UUID. Set a new value when creating a new metric, or use an existing value when overwiriting one.
{{MetricLabel}}: metric label.
{{MetricWarningText}}: warning text to be displayed with the metric.
{{NormalizeDatasetColumns}}: set to true to change columns to case insensitive format (applicable to Oracle and Snowflake).
{{DatasetOffset}}: number of hours (positive or negative) to shift the time column.
owners: list of {{OwnerID}} values, retrived via the Get all possible Dataset Owners endpoint.
{{SchemaName}}: schema the dataset is associated with.
{{SQLQuery}}: SQL query powering the dataset (only applicable to virtual datasets).
{{TableName}}: indicate the table name for physical datasets, and the dataset name for virtual datasets.
{{TemplateParams}}: stringified JSON to define Jinja template parameters.
Refreshes and updates columns of a Dataset.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{DatasetID}} with the Dataset id retrieved from the Get All Datasets from a Workspace endpoint.Deletes a Dataset.
\nReplace in the URL and in the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{DatasetID}} with the Dataset id retrieved from the Get All Datasets from a Workspace endpoint.APIs to manage your datasets.
\n","_postman_id":"b5804081-0ace-4b97-b00d-5c4c96e59949","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JWTToken}}"}]},"isInherited":true,"source":{"_postman_id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","name":"Preset API","type":"collection"}}},{"name":"Query History","item":[{"name":"Get Query History","id":"af912d3e-6c6f-4ad1-8371-e127abd7583c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/api/v1/query/","description":"Gets Query History from the Workspace.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
Note that this endpoint returns 20 results by default. You can return up to 100 results at a time and use pagination by adding the following query parameters:
\n?q=(page_size:{{PageSize}},page:{{Page}})\n\nReplace:
\n{{PageSize}} with the desired size (min 1 max 100).
{{Page}} with the page number (useful when the total count > {{PageSize}} - min 0).
Gets a query from the Workspace.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{QueryID}} with the query id retrieved from the Get Query History or the Execute a SQL Query API endpoints.Executes a SQL query through the API.
\nReplace in the URL and in the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).
{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:
Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
Replace in the body:
\n{{DBID}} with the id retrieved from the Get all Database Connections from a Workspace endpoint.
{{SQLQuery}} with the desired SQL query to be executed. Don't forget to escape quotes with \\. For example:
{\n \"database_id\": 1,\n \"sql\": \"SELECT * FROM \\\"Vehicle Sales\\\" limit 7\" \n }\n\nGets all Tags from a Workspace.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
Note that this endpoint returns 20 results by default. You can return up to 100 results at a time and use pagination by adding the following query parameters:
\n?q=(page_size:{{PageSize}},page:{{Page}})\n\nReplace:
\n{{PageSize}} with the desired size (min 1 max 100).{{Page}} with the page number (useful when the total count > {{PageSize}} - min 0).(optional) Used to control pagination and page size (max page size = 100).
\n","type":"text/plain"},"key":"q","value":"(page:0,page_size:100)"}],"variable":[]}},"response":[],"_postman_id":"9afeae42-47f3-4407-afea-98ee6ef67c4f"},{"name":"Get a Tag","id":"be323ccb-d331-4731-9636-9315e2b5ac17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"url":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/api/v1/tag/{{TagID}}","description":"Gets a specific Tag from a Workspace.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{TagID}} with the tag id retrieved from the Get all Tags from a Workspace endpoint.Gets al Assets associated with a specific Tag from a Workspace.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{TagName}} with the tag title.Creates a Tag through the API.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
Replace in the body:
\n{{TagDescription}} (optional) with the tag description.
{{TagName}} with the tag name.
objects_to_tag (optional) is an array that can be used to associate this tag with assets during creation. For each asset that should be associated with the tag, include an array of [\"{{AssetType}}\", {{AssetID}}] replacing:
{{AssetType}} with chart, dashboard or query.
{{AssetID}} with the actual asset ID.
Adds Tags in bulk to Assets through the API.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
For each tag that should be associated with an asset, add a new dictionary to the tags array with the following information:
{{TagName}} with the name of the tag that should be used.objects_to_tag with an array of arrays containing the assets' information. For each asset that should be associated with the tag, include an array of [\"{{AssetType}}\", {{AssetID}}] replacing:{{AssetType}} with chart, dashboard or query.{{AssetID}} with the actual asset ID.Note that this endpoint can't be used to create tags. Use it to associate existing tags to existing assets.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JWTToken}}"}]},"isInherited":true,"source":{"_postman_id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","name":"Preset API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","tag","bulk_create"],"host":["{{WorkspaceSlug}}","{{WorkspaceRegion}}","app","preset","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"f38eb17c-b431-4987-a3d4-6b888c71cf78"},{"name":"Update a Tag","id":"68a7fff6-7c70-45fe-9ebd-102b5a6f6167","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{JWTToken}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"description\": \"{{TagDescription}}\",\n \"name\": \"{{TagName}}\",\n \"objects_to_tag\": [\n [\n \"{{AssetType}}\",\n {{AssetID}}\n ]\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://{{WorkspaceSlug}}.{{WorkspaceRegion}}.app.preset.io/api/v1/tag/{{TagID}}","description":"Updates an existing Tag through the API.
\nReplace in the URL:
\n{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{TagID}} with the id of the tag retrieved with the Get all Tags from the Workspace API endoint.Replace in the body:
\n{{TagDescription}} with the tag description.
{{TagName}} with the tag name.
objects_to_tag is an array that can be used to associate this tag with assets. For each asset that should be associated with the tag, include an array of [\"{{AssetType}}\", {{AssetID}}] replacing:
{{AssetType}} with chart, dashboard or query.
{{AssetID}} with the actual asset ID.
Deletes a Tag through the API.
\nReplace in the URL and on the Referer header:
{{WorkspaceSlug}} with the name retrieved through the API (using the Get Workspaces from a Team endpoint).{{WorkspaceRegion}} corresponding to the region retrieved from the Get Workspaces from a Team endpoint. Refer to below table:Alternatively, access the Workspace through the UI, and get the {{WorkspaceSlug}} and {{WorkspaceRegion}} from the URL -> https://{{WorkspaceSlug}}.{{Region}}.app.preset.io/superset/welcome/.
{{TagID}} with the id of the tag retrieved from the Get all Tags from a Workspace API endpoint.Superset APIs can be used to interact with assets in your Workspaces. Note that Superset APIs are contributed from the Open Source Community, so they are subject to change without previous notification. Please keep this in mind when working with them.
\n","_postman_id":"5b442377-2010-4e0b-849a-36aac415d657","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JWTToken}}"}]},"isInherited":true,"source":{"_postman_id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","id":"9dc44bfa-078a-4f14-98f4-7b35338e5928","name":"Preset API","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{JWTToken}}"}]}},"event":[{"listen":"prerequest","script":{"id":"5e5f9541-8fc4-4589-a6aa-8b3ae4fa49b5","type":"text/javascript","requests":{},"exec":["//AUTHENTICATION HANDLER","","//Function to get a new JWT Token","function generateNewJWT() {"," const postRequest = {"," url: 'https://manage.app.preset.io/api/v1/auth/',"," method: 'POST',"," header: {"," 'Content-Type': 'application/json',"," },"," body: {"," mode: 'raw',"," raw: JSON.stringify({ name: APIName, secret: APISecret })"," }"," };"," pm.sendRequest(postRequest, (error, response) => {"," if (error) {"," console.error(\"We couldn't get a new JWT Token\");"," console.error(error);"," } else {"," if (response.code == 200) {"," var temp = response.json();"," pm.globals.set(\"JWTToken\", temp[\"payload\"][\"access_token\"]);"," } else {"," console.error(\"We couldn't get a new JWT Token\");"," console.error(response);"," }"," }"," });","};","","//Check if the JWTToken Global Variable is currently set","var currentToken = pm.globals.get(\"JWTToken\");","//Check if API Token & Secret are defined","var APIName = pm.collectionVariables.get(\"APIToken\");","var APISecret = pm.collectionVariables.get(\"APISecret\");","if (!currentToken) {"," console.log(\"JWT Token not defined.\");"," if (!APIName || !APISecret) {"," console.error(\"Unable to generate a new JWT token - Missing authentication information.\");"," } else {"," console.log(\"Let's get a JWT Token\");"," generateNewJWT();"," }","} else {"," console.log(\"Let's check if the JWT is still valid\");",""," //Uses the /api/v1/users/me/ endpoint to check if authentication succeeds"," const getRequest = {"," url: 'https://manage.app.preset.io/api/v1/users/me/',"," method: 'GET',"," header: {"," 'Accept': 'application/json',"," 'Authorization': 'Bearer ' + currentToken"," }"," };"," pm.sendRequest(getRequest, (error, response) => {"," if (error) {"," console.error(\"Something went wrong\");"," console.error(error);"," } else {"," if (response.code == 200) {"," console.log(\"Authentication succeeded - let's proceed.\");"," } else {"," console.warn(\"Authentication failed - let's get a new JWT Token\");"," if (!APIName || !APISecret) {"," console.error(\"Unable to generate a new JWT token - Missing authentication information.\");"," } else {"," generateNewJWT();"," }"," }"," }"," });","}"]}},{"listen":"test","script":{"id":"34d767b3-595b-4be5-897f-d22aa4384682","type":"text/javascript","requests":{},"exec":[""]}}],"variable":[{"key":"APIToken","value":"{{APIToken}}"},{"key":"APISecret","value":"{{APISecret}}"},{"key":"TeamSlug","value":"{{TeamSlug}}"},{"key":"NewTeamTitle","value":"{{NewTeamTitle}}"},{"key":"UserID","value":"{{UserID}}"},{"key":"RoleID","value":"{{RoleID}}"},{"key":"InviteID","value":"{{InviteID}}"},{"key":"Email","value":"{{Email}}"},{"key":"Email2","value":"{{Email2}}"},{"key":"NewWorkspaceTitle","value":"{{NewWorkspaceTitle}}"},{"key":"NewWorkspaceRegion","value":"{{NewWorkspaceRegion}}"},{"key":"WorkspaceID","value":"{{WorkspaceID}}"},{"key":"RoleIdentifier","value":"{{RoleIdentifier}}"},{"key":"WorkspaceSlug","value":"{{WorkspaceSlug}}"},{"key":"WorkspaceRegion","value":"{{WorkspaceRegion}}"},{"key":"Username","value":"{{Username}}"},{"key":"PermissionName","value":"{{PermissionName}}"},{"key":"Resource","value":"{{Resource}}"},{"key":"WorkspaceRole","value":"{{WorkspaceRole}}"},{"key":"ChartID","value":"{{ChartID}}"},{"key":"ChartIDs","value":"{{ChartIDs}}"},{"key":"DashboardID","value":"{{DashboardID}}"},{"key":"DashboardIDs","value":"{{DashboardIDs}}"},{"key":"NewDashboardName","value":"{{NewDashboardName}}"},{"key":"CertificationDetails","value":"{{CertificationDetails}}"},{"key":"CertifiedBy","value":"{{CertifiedBy}}"},{"key":"EmbeddedDashboardID","value":"{{EmbeddedDashboardID}}"},{"key":"firstName","value":"{{firstName}}"},{"key":"lastName","value":"{{lastName}}"},{"key":"PermissionType","value":"{{PermissionType}}"},{"key":"DatabaseYAMLFile","value":"{{DatabaseYAMLFile}}"},{"key":"DatabasePassword","value":"{{DatabasePassword}}"},{"key":"ResourceType","value":"{{ResourceType}}"},{"key":"GranteeIdentifier","value":"{{GranteeIdentifier}}"},{"key":"ResourceName","value":"{{ResourceName}}"},{"key":"GranteeType","value":"{{GranteeType}}"},{"key":"DARName","value":"{{DARName}}"},{"key":"GrantAction","value":"{{GrantAction}}"},{"key":"RLSName","value":"{{RLSName}}"},{"key":"RLSClause","value":"{{RLSClause}}"},{"key":"RLSFilterType","value":"{{RLSFilterType}}"},{"key":"RLSGroupKey","value":"{{RLSGroupKey}}"},{"key":"DARName1","value":"{{DARName1}}"},{"key":"DARName2","value":"{{DARName2}}"},{"key":"DatabaseIDs","value":"{{DatabaseIDs}}"},{"key":"DatasetIDs","value":"{{DatasetIDs}}"},{"key":"AnnotationLayerID","value":"{{AnnotationLayerID}}"},{"key":"AnnotationLayerDescription","value":"{{AnnotationLayerDescription}}"},{"key":"AnnotationLayerName","value":"{{AnnotationLayerName}}"},{"key":"AnnotationID","value":"{{AnnotationID}}"},{"key":"AnnotationEndDTTM","value":"{{AnnotationEndDTTM}}"},{"key":"AnnotationLongDescription","value":"{{AnnotationLongDescription}}"},{"key":"AnnotationTitle","value":"{{AnnotationShortDescription}}"},{"key":"AnnotationStartDTTM","value":"{{AnnotationStartDTTM}}"},{"key":"AnnotationIDs","value":"{{AnnotationIDs}}"},{"key":"AnnotationLayerIDs","value":"{{AnnotationLayerIDs}}"},{"key":"AlertID OR ReportID","value":"{{AlertID OR ReportID}}"},{"key":"DatasetID","value":"{{DatasetID}}"},{"key":"DBConnectionExtraConfiguration","value":"{{DBConnectionExtraConfiguration}}"},{"key":"ReportName","value":"{{ReportName}}"},{"key":"ReportDescription","value":"{{ReportDescription}}"},{"key":"CRONSchedule","value":"{{CRONSchedule}}"},{"key":"Timezone","value":"{{Timezone}}"},{"key":"ForceBooleanFlag","value":"{{ForceBooleanFlag}}"},{"key":"ReportFormat","value":"{{ReportFormat}}"},{"key":"OwnerID","value":"{{OwnerID}}"},{"key":"ReportType","value":"{{ReportType}}"},{"key":"TargetInfo","value":"{{TargetInfo}}"},{"key":"LogRetention","value":"{{LogRetention}}"},{"key":"WorkingTimeout","value":"{{WorkingTimeout}}"},{"key":"GracePeriod","value":"{{GracePeriod}}"},{"key":"AlertName","value":"{{AlertName}}"},{"key":"AlertDescription","value":"{{AlertDescription}}"},{"key":"AlertFormat","value":"{{AlertFormat}}"},{"key":"DatabaseID","value":"{{DatabaseID}}"},{"key":"SQLCondition","value":"{{SQLCondition}}"},{"key":"ValidatorType","value":"{{ValidatorType}}"},{"key":"Operator","value":"{{Operator}}"},{"key":"Threshold","value":"{{Threshold}}"},{"key":"DatasetSQL","value":"{{DatasetSQL}}"},{"key":"ActiveBooleanFlag","value":"{{ActiveBooleanFlag}}"},{"key":"SQLQuery","value":"{{SQLQuery}}"},{"key":"SSHServerPassword","value":"{{SSHServerPassword}}"},{"key":"SSHServerAddress","value":"{{SSHServerAddress}}"},{"key":"PrivateKey","value":"{{PrivateKey}}"},{"key":"PrivateKeyPassword","value":"{{PrivateKeyPassword}}"},{"key":"SSHUsername","value":"{{SSHUsername}}"},{"key":"DBConnectionName","value":"{{DBConnectionName}}"},{"key":"DatasetType","value":"{{DatasetType}}"},{"key":"VisualizationType","value":"{{VisualizationType}}"},{"key":"RowLimit","value":"{{RowLimit}}"},{"key":"EntityType","value":"{{EntityType}}"},{"key":"EntityID","value":"{{EntityID}}"},{"key":"EntityName","value":"{{EntityName}}"},{"key":"ActionURN","value":"{{ActionURN}}"},{"key":"UsernameOREmail","value":"{{UsernameOREmail}}"},{"key":"StartTime","value":"{{StartTime}}"},{"key":"EndTime","value":"{{EndTime}}"},{"key":"PageNumber","value":"{{PageNumber}}"},{"key":"PageSize","value":"{{PageSize}}"},{"key":"OrderColumn","value":"{{OrderColumn}}"},{"key":"SortOption","value":"{{SortOption}}"},{"key":"AllowedDomain","value":"{{AllowedDomain}}"},{"key":"TagID","value":"{{TagID}}"},{"key":"TagDescription","value":"{{TagDescription}}"},{"key":"TagName","value":"{{TagName}}"},{"key":"AssetType","value":"{{AssetType}}"},{"key":"AssetID","value":"{{AssetID}}"},{"key":"Published","value":"{{Published}}"},{"key":"DashboardSlug","value":"{{DashboardSlug}}"},{"key":"JSONMetadata","value":"{{JSONMetadata}}"},{"key":"PositionJSON","value":"{{PositionJSON}}"},{"key":"DBConnectionAllowCTAS","value":"{{DBConnectionAllowCTAS}}"},{"key":"DBConnectionAllowCVAS","value":"{{DBConnectionAllowCVAS}}"},{"key":"DBConnectionAllowDML","value":"{{DBConnectionAllowDML}}"},{"key":"DBConnectionEnableAsyncQueries","value":"{{DBConnectionEnableAsyncQueries}}"},{"key":"DBConnectionCacheTimeOut","value":"{{DBConnectionCacheTimeOut}}"},{"key":"DBConnectionExposeInSQLLab","value":"{{DBConnectionExposeInSQLLab}}"},{"key":"DBConnectionSQLAlchemyURI","value":"{{DBConnectionSQLAlchemyURI}}"},{"key":"PublicKey","value":"{{PublicKey}}"},{"key":"KeyID","value":"{{KeyID}}"},{"key":"NewWorkspaceDescription","value":"{{NewWorkspaceDescription}}"},{"key":"NewWorkspaceColor","value":"{{NewWorkspaceColor}}"},{"key":"NewWorkspaceIcon","value":"{{NewWorkspaceIcon}}"},{"key":"MPCClusterID","value":"{{MPCClusterID}}"},{"key":"QueryID","value":"{{QueryID}}"},{"key":"EnableDrilling","value":"","type":"default"}]}