Dot
Ask or search…
K
Links

API

automate as much as you like

Automatically Sync Dot

To keep Dot in sync with your production environment, it is recommended to trigger the following API endpoint
post
/api/sync/{connection_type}/{connection_id}
Sync Connection
// URL endpoint
https://{region}.getdot.ai/api/sync/{connection_type}/{connection_type}?user_id={user}&api_token={api_token}
  • Region: app (US) or eu (EU)
  • Connection Type: postgres, redshift, snowflake, mssql, bigquery, databricks, looker, dbt
  • User ID: usually email of the user (url encoded)
  • API Token: can get created (and overwritten) by clicking Copy API Token in Settings/Users/Actions/···
Trigger with curl (CLI)
curl -X "POST" "https://eu.getdot.ai/api/sync/bigquery/my-bg-id?user_id=sync_user%40contoso.com&api_token=42673584be9724a21e1550336d6fe509f4a04207461ec9a926ca2a27cbd27fa0
Trigger with dbt webhooks
Call the api endpoint after your dbt run completed.
Webhooks for your jobs | dbt Developer Hub
Documentation how to setup a dbt webhooks

Other Use Cases

Authentication

For most operations on Dot you first need to login
post
/api/auth/token
Login For Access Token

User Administration

get
/api/get_users
Get All Users
post
/api/send_invitations
Sendinvitations
post
/api/delete_user
Delete User Route
post
/api/change_user_role
Change User Role
post
/api/add_user_to_group
Add User To Group
post
/api/remove_user_from_group
Remove User From Group

Ask questions

post
/api/ask_with_history
Ask With History
post
/api/ask
Ask
Last modified 16d ago