Skip to main content
Metabase
Previewv0.3.0
337 actions · 1 event · 2 auth methods
AnalyticsIAM

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and create a Connector Profile in your project. See Setup Connector Profile.

API Key · Connector Profile

Uses a Metabase API key, for self-hosted Metabase or Metabase Cloud. The key acts with the permissions of the group it b…

Username and Password · Connector Profile

Signs in as a Metabase user with an email and password. Actions run with that user’s permissions, and accounts that sign…
Optionally, configure receiving Events for Metabase into StackOne.

Webhooks setup

3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

API Key · Link Account

Username and Password · Link Account

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

|
337 actions
Action
Description
List Actions
Returns the actions the current user can read, unarchived unless ?archived=true.
List Public Actions
Fetch a list of Actions with public UUIDs.
Get Action
Fetch an Action.
Create Action
Create a new action.
Create Action Public Link
Generate publicly-accessible links for this Action.
Update Action
Update an Action.
Execute Action
Execute the Action.
Get Action Execute Values
Fetches the values for filling in execution parameters.
Delete Action
Delete an Action.
Delete Action Public Link
Delete the publicly-accessible link to this Dashboard.
List Popular Items
Get the list of 5 popular things on the instance.
List Recent Items
Get a list of recent items the current user has been viewing most recently under the recents key.
Get Most Recently Viewed Dashboard
Get the most recently viewed dashboard for the current user.
List Alerts
Fetch alerts which the current user has created or will receive, or all alerts if the user is an admin.
Get Alert
Fetch an alert by ID.
List API Keys
List the API keys in a Metabase instance, with the group each key belongs to.
Count API Keys
Get the count of API keys in the DB with the default scope.
Create API Key
Create a new API key (and an associated User) with the provided name and group ID.
Regenerate API Key
Regenerate an API Key.
Update API Key
Update an API key by changing its group and/or its name.
Delete API Key
Delete an ApiKey.
List Bookmarks
Fetch all bookmarks for the user.
Create Bookmark
Create a new bookmark for user.
Reorder Bookmarks
Sets the order of bookmarks for user.
Delete Bookmark
Delete a bookmark.
List Cache Configs
Return cache configuration.
Update Cache Config
Store cache configuration.
Invalidate Cache
Invalidate cache entries.
Delete Cache Config
Delete cache configurations.
List Card Dashboards
Get a list of {:name …
List Card Series
Fetches a list of compatible series with the card with id card_id.; last_cursor with value is the id of the last card fr…
List Cards
Get all the Cards.
List Embeddable Cards
Fetch a list of Cards where enable_embedding is true.
List Public Cards
Fetch a list of Cards with public UUIDs.
Search Card Parameter Values
Fetch possible values of the parameter whose ID is param-key that contain query.
Get Card
Get Card with ID.
Get Card Parameter Remapping
Fetch the remapped value for a given value of the parameter with ID param-key.
Get Card Parameter Values
Fetch possible values of the parameter whose ID is param-key.
Get Card Query Metadata
Get all of the required query metadata for a card.
Create Card
Create a new Card.
Create Card Public Link
Generate publicly-accessible links for this Card.
Update Card
Update a Card.
Copy Card
Copy a Card, with the new name ‘Copy of name’.
Export Card Query
Run the query associated with a Card, and return its results as a file in the specified format.
List Cards Dashboards
Get the dashboards that multiple cards appear in.
Move Cards
Moves a number of Cards to a single collection or dashboard.
Move Cards To Collection
Bulk update endpoint for Card Collections.
Query Card
Run the query associated with a Card.
Query Card Pivot
Run the query associated with a Card.
Delete Card
Hard delete a Card.
Delete Card Public Link
Delete the publicly-accessible link to this Card.
List Channels
Get all channels.
Get Channel
Get a channel.
Create Channel
Create a channel.
Update Channel
Update a channel.
Test Channel
Test a channel connection.
List Collection Dashboard Question Candidates
Find cards in this collection that can be moved into dashboards in this collection.
List Collection Items
Fetch a specific Collection’s items with the following options - models - only include objects of a specific set of mode…
List Collections
Fetch a list of all Collections that the current user has read permissions for (can_write is returned as an additional p…
List Root Collection Items
Fetch objects that the current user should see at their root level.
List Root Dashboard Question Candidates
Find cards in the root collection that can be moved into dashboards in the root collection.
Get Collection
Fetch a specific Collection with standard details added.
Get Collection Items Metadata
Metadata about the collection’s items list - the models with at least one visible item plus the item count.
Get Collection Permissions Graph
Fetch a graph of all Collection Permissions.
Get Collection Root
Return the ‘Root’ Collection object with standard details added.
Get Collection Trash
Fetch the trash collection, as in /api/collection/:trash-id.
Get Collection Tree
Similar to GET /, but returns Collections in a tree structure, e.g.
Get Root Collection Items Metadata
Metadata about the Root Collection’s items list - the models with at least one visible item plus the item count.
Create Collection
Create a new Collection.
Update Collection
Modify an existing Collection, including archiving or unarchiving it, or moving it.
Update Collection Permissions Graph
Do a batch update of Collections Permissions by passing in a modified graph.
Move Dashboard Question Candidates
Move candidate cards to the dashboards they appear in.
Move Root Dashboard Question Candidates
Move candidate cards to the dashboards they appear in (for the root collection)
Delete Collection
Deletes a collection permanently. It must be in the trash first (update_collection with archived true); otherwise Metaba…
List Comments
Get comments for an entity.
List Mentionable Users
Get a list of entities suitable for mentions.
Create Comment
Create a new comment.
Update Comment
Update a comment.
Toggle Comment Reaction
Toggle a reaction on a comment.
Delete Comment
Soft delete a comment.
List Dashboard Items
Get Dashboard with ID.
List Embeddable Dashboards
Fetch a list of Dashboards where enable_embedding is true.
List Public Dashboards
Fetch a list of Dashboards with public UUIDs.
List Valid Filter Fields
Utility endpoint for powering Dashboard UI.
Search Dashboard Parameter Values
Fetch possible values of the parameter whose ID is param-key that contain query.
Get Dashboard
Get Dashboard with ID.
Get Dashboard Parameter Remapping
Fetch the remapped value for a given value of the parameter with ID param-key.
Get Dashboard Parameter Values
Fetch possible values of the parameter whose ID is param-key.
Get Dashboard Query Metadata
Get all of the required query metadata for the cards on dashboard.
Get Dashboard Related
Return related entities.
Create Dashboard
Create a new Dashboard.
Create Dashboard Public Link
Generate publicly-accessible links for this Dashboard.
Update Dashboard
Update a Dashboard, and optionally the dashcards and tabs of a Dashboard.
Copy Dashboard
Copy a Dashboard.
Execute Dashcard Action
Execute the associated Action in the context of a Dashboard and DashboardCard that includes it.
Export Dashboard PDF
Render Dashboard with ID to a PDF (server-side, the same way dashboard subscriptions render charts) and stream it back a…
Export Dashcard Query
Run the query associated with a Saved Question (Card) in the context of a Dashboard that includes it, and return its res…
Get Dashcard Action Execute Values
Fetches the values for filling in execution parameters.
Query Dashcard
Run the query associated with a Saved Question (Card) in the context of a Dashboard that includes it.
Query Dashcard Pivot
Run a pivot table query for a specific DashCard.
Save Dashboard
Save a denormalized description of dashboard.
Save Dashboard To Collection
Save a denormalized description of dashboard into collection with ID parent-collection-id.
Delete Dashboard
Hard delete a Dashboard.
Delete Dashboard Public Link
Delete the publicly-accessible link to this Dashboard.
List Database Fields
Get a list of all Fields in Database.
List Database ID Fields
Get a list of all primary key Fields for Database.
List Database Schema Tables
Returns a list of Tables for the given Database id and schema.
List Database Schema Tables By Query
Return a list of Tables for a Database whose schema is the schema query parameter, or nil or an empty string when no sch…
List Database Schemas
Returns a list of all the schemas with tables found for the database id.
List Database Syncable Schemas
Returns a list of all syncable schemas found for the database id.
List Databases
Fetch all Databases.; include=tables means we should hydrate the Tables belonging to each DB.
List Virtual Database Datasets
Returns a list of all the datasets found for the saved questions virtual database.
List Virtual Database Schema Datasets
Returns a list of Tables for the datasets virtual database.
List Virtual Database Schema Tables
Returns a list of Tables for the saved questions virtual database.
List Virtual Database Schemas
Returns a list of all the schemas found for the saved questions virtual database.
Get Database
Get a single Database with id.
Get Database Autocomplete Suggestions
Return a list of autocomplete suggestions for a given prefix, or substring.
Get Database Card Autocomplete Suggestions
Return a list of Card autocomplete suggestions for a given query in a given Database.
Get Database Healthcheck
Reports whether the database can currently connect.
Get Database Metadata
Get metadata about a Database, including all of its Tables and Fields.
Get Database Settings Available
Get all database-local settings and their availability for the given database.
Get Database Usage Info
Get usage info for a database.
Get Virtual Database Metadata
Endpoint that provides metadata for the Saved Questions ‘virtual’ database.
Create Database
Add a new Database.
Update Database
Update a Database.
Add Sample Database
Add the sample database as a new Database.
Discard Database Field Values
Discards all saved field values for this Database.
Rescan Database Field Values
Trigger a manual scan of the field values for this Database.
Sync Database Schema
Trigger a manual update of the schema metadata for this Database.
Validate Database
Validate that we can connect to a database given a set of details.
Delete Database
Delete a Database.
Search Dataset Parameter Values
Return parameter values for cards or dashboards that are being edited.
Export Dataset Query
Execute a query and download the result data as a file in the specified format.
Get Dataset Parameter Remapping
Return the remapped parameter values for cards or dashboards that are being edited.
Get Dataset Parameter Values
Return parameter values for cards or dashboards that are being edited.
Get Dataset Query Metadata
Get all of the required query metadata for an ad-hoc query.
Get Native Query
Fetch a native version of an MBQL query.
Run Dataset Query
Execute a query and retrieve the results in the usual format.
Run Pivot Dataset Query
Generate a pivoted dataset for an ad-hoc query.
List Documents
Gets existing Documents.
List Public Documents
List all Documents that have public links.
Get Document
Returns an existing Document by ID.
Create Document
Create a new Document.
Create Document Public Link
Generate a publicly-accessible UUID for a Document.
Update Document
Updates an existing Document.
Copy Document
Copy a Document.
Export Document Card Query
Download query results for a Card embedded in a Document.
Delete Document
Permanently deletes a document. It must be archived first (update_document with archived true); otherwise Metabase retur…
Delete Document Public Link
Remove the public link for a Document.
Search Field Values
Search a field’s values for text.
Get Field
Get Field with ID.
Get Field Related
Return related entities.
Get Field Remapping
Fetch remapped Field values.
Get Field Summary
Get the count and distinct count of Field with ID.
Get Field Values
If a Field’s value of has_field_values is list, return a list of all the distinct values of the Field (or remapped Field…
Create Field Dimension
Sets the dimension for the given field at ID.
Update Field
Update Field with ID.
Update Field Values
Update the fields values and human-readable values for a Field whose semantic type is category/city/state/country or who…
Discard Field Values
Discard the FieldValues belonging to this Field.
Get Field Table IDs
Get unique Table IDs for a list of Field IDs.
Rescan Field Values
Manually trigger an update for the FieldValues for this Field.
Delete Field Dimension
Remove the dimension associated to field at ID.
List Glossary Terms
Fetch all glossary entries, optionally filtered by search term.
Create Glossary Term
Create a new glossary entry.
Update Glossary Term
Update an existing glossary entry.
Delete Glossary Term
Delete a glossary entry.
List Groups
List the permission groups in a Metabase instance, with member counts.
Get Group
Get a Metabase permission group by ID, with its members.
List Group Memberships
List the group memberships in a Metabase instance, keyed by user id.
List Invite Group IDs
IDs of the permission groups holding a stored read (or read-write) grant on the collection of a shareable item (a dashbo…
Create Group
Create a new PermissionsGroup.
Create Group Membership
Add a User to a PermissionsGroup.
Clear Group Memberships
Remove all members from a PermissionsGroup.
Update Group
Update the name of a PermissionsGroup.
Update Group Membership
Update a Permission Group membership.
Delete Group
Delete a specific PermissionsGroup.
Delete Group Membership
Remove a User from a PermissionsGroup (delete their membership).
Get Unified Credentials
Get the current Metabase connection’s unified credentials and identity.
List Unified Groups
List unified permission groups in a Metabase instance.
Get Unified Group
Get a unified Metabase permission group by ID.
List Unified Roles
List unified roles in Metabase.
Get Unified Role
Get a unified Metabase role by ID.
List Unified Users
List unified users in a Metabase instance.
Get Unified User
Get a unified Metabase user by ID.
List Login History
Fetch recent logins for the current user.
List Measures
Fetch *all* Measures.
Search Measure Dimension Values
Search for values of a dimension that contain the query string.
Get Measure
Fetch Measure with ID.
Get Measure Dimension Remapping
Fetch remapped value for a specific dimension value.
Get Measure Dimension Values
Fetch values for a dimension of a measure.
Create Measure
Create a new Measure.
Update Measure
Update a Measure with ID.
List Metric Dimensions
List a metric’s curated dimensions, and (when with-addable=true) the columns still available to add, grouped by source t…
List Metrics
Get a list of metrics.
Search Metric Dimension Values
Search for values of a dimension that contain the query string.
Get Metric
Fetch a Metric with ID.
Get Metric Dimension Remapping
Fetch remapped value for a specific dimension value.
Get Metric Dimension Values
Fetch values for a dimension of a metric.
Update Metric Dimension
Update a metric dimension’s display_name, description, default_temporal_unit, and/or source column.
Add Metric Dimension
Add dimensions to a metric.
Get Metric Breakout Values
Fetch distinct breakout dimension values for a metric or measure definition.
Remove Metric Dimension
Remove dimensions (by UUID) from a metric.
Reorder Metric Dimensions
Persist a new ordering for a metric’s dimensions.
Run Metric Dataset Query
Execute a metric or measure-based query and stream the results.
Set Default Metric Dimension
Mark exactly one dimension as the metric’s default, clearing any previous default.
List Model Indexes
Retrieve list of ModelIndex.
Get Model Index
Retrieve ModelIndex.
Create Model Index
Create ModelIndex.
Delete Model Index
Delete ModelIndex.
Create Moderation Review
Create a new ModerationReview.
List Admin Notifications
List card-type notifications (alerts) for admin management.
List Notifications
List notifications.; creator_id - if provided returns only notifications created by this user; recipient_id - if provide…
Get Admin Notification
Get a single card-type notification with last_check, last_send, check_history (up to 10 most-recent terminal alert-type…
Get Notification
Get a notification by id.
Create Notification
Create a new notification, return the created notification.
Update Notification
Update a notification, can also update its subscriptions, handlers.
Bulk Update Admin Notifications
Bulk-archive or -change-creator a set of notifications.
Send Notification
Send a notification by id.
Send Unsaved Notification
Send an unsaved notification.
Get Database Permissions Graph
Fetch a graph of all Permissions for db-id db-id.
Get Group Permissions Graph
Fetch a graph of all Permissions for group-id group-id.
Get Permissions Graph
Fetch a graph of all Permissions.
Update Permissions Graph
Do a batch update of Permissions by passing in a modified graph.
List Persisted Models
List the entries of PersistedInfo in order to show a status page.
Get Persisted Card
Fetch a particular PersistedInfo by card-id.
Get Persisted Info
Fetch a particular PersistedInfo by id.
Disable Model Persistence
Disable global setting to allow databases to persist models.
Enable Model Persistence
Enable global setting to allow databases to persist models.
Persist Card
Mark the model (card) as persisted.
Persist Database
Attempt to enable model persistence for a database.
Refresh Persisted Card
Refresh the persisted model caching card-id.
Set Persist Refresh Schedule
Set the cron schedule to refresh persisted models.
Unpersist Card
Unpersist this model.
Unpersist Database
Attempt to disable model persistence for a database.
List Pulses
Fetch all dashboard subscriptions.
Get Pulse
Fetch Pulse with ID.
Get Pulse Form Input
Provides relevant configuration information and user choices for creating/updating Pulses.
Create Pulse
Create a new Pulse.
Update Pulse
Update a Pulse with id.
Test Pulse
Test send an unsaved pulse.
List Entity Revisions
Fetch Revisions for an object with ID.
List Revisions
Get revisions of an object.
Revert Revision
Revert an object to a prior revision.
Search
Search for items in Metabase.
Get Search Weights
Return the current weights being used to rank the search results.
Update Search Weights
Update the current weights being used to rank the search results.
Force Search Reindex
This will trigger an immediate reindexing, if we are using search index.
Reinitialize Search Index
This will blow away any search indexes, re-create, and re-populate them.
List Segments
Fetch *all* Segments.
Get Segment
Fetch Segment with ID.
Get Segment Related
Return related entities.
Create Segment
Create a new Segment.
Update Segment
Update a Segment with ID.
List Settings
Get all Settings and their values.
Get Setting
Fetch a single Setting.
Update Setting
Create/update a Setting.
Update Settings
Update multiple Settings values.
List Native Query Snippets
Fetch all snippets.
Get Native Query Snippet
Fetch native query snippet with ID.
Create Native Query Snippet
Create a new NativeQuerySnippet.
Update Native Query Snippet
Update an existing NativeQuerySnippet.
List Table FKs
Get all foreign keys whose destination is a Field that belongs to this Table.
List Tables
Get all Tables.
Get Card Table Query Metadata
Return metadata for the ‘virtual’ table for a Card.
Get Table
Get Table with ID.
Get Table Data
Get the data for the given table.
Get Table Query Metadata
Get metadata about a Table useful for running queries.
Get Table Related
Return related entities.
Reorder Table Fields
Reorder fields.
Update Table
Update Table with ID.
Append CSV To Table
Inserts the rows of an uploaded CSV file into the table identified by id.
Discard Table Field Values
Discard the FieldValues belonging to the Fields in this Table.
Replace Table CSV
Replaces the contents of the table identified by id with the rows of an uploaded CSV file.
Rescan Table Field Values
Manually trigger an update for the FieldValues for the Fields belonging to this Table.
Sync Table Schema
Trigger a manual update of the schema metadata for this Table.
Upload CSV
Create a table and model populated with the values from the attached CSV.
List Task Run Entities
Get distinct entities that have task runs for a given run type.
List Task Runs
List task runs with optional filters.
List Tasks
Fetch a list of recent tasks stored as Task History.
List Unique Tasks
Returns possibly empty vector of unique task names in alphabetical order.
Get Task
Get TaskHistory entry with ID.
Get Task Info
Return raw data about all scheduled tasks (i.e., Quartz Jobs and Triggers).
Get Task Run
Get a single task run with all its child tasks.
Get Timeline Event
Fetch the TimelineEvent with id.
Create Timeline Event
Create a new TimelineEvent.
Update Timeline Event
Update a TimelineEvent.
Delete Timeline Event
Delete a TimelineEvent.
List Collection Timelines
Fetch a specific Collection’s timelines.
List Root Collection Timelines
Fetch the root Collection’s timelines.
List Timelines
Fetch a list of Timelines.
Get Timeline
Fetch the Timeline with id.
Create Timeline
Create a new Timeline.
Update Timeline
Update the Timeline with id.
Delete Timeline
Delete a Timeline.
List Transform Job Run Transform Runs
Get the transform runs that made up a specific job run.
List Transform Job Runs
Get paginated run history for a transform job.
List Transform Job Transforms
Get the transforms of job specified by the job’s ID.
List Transform Jobs
Get all transform jobs.
Get Transform Job
Get a transform job by ID.
Create Transform Job
Create a new transform job.
Set Transform Jobs Active
Activate or deactivate every transform job.
Update Transform Job
Update a transform job.
Cancel Transform Job Run
Cancel an in-progress job run and request cancellation of its still-running transforms.
Run Transform Job
Run a transform job manually.
Delete Transform Job
Delete a transform job.
List Transform DAG Transforms
Preview the transforms a DAG reprocess from this transform would run (see POST /:id/run-dag), in execution order.
List Transform Runs
Paginated unified run history - every row is a root run — a job run, a manual DAG-reprocess run, or a standalone transfo…
List Transforms
Get a list of transforms.
Search Transform Runs
Get transform runs based on a set of filter params.
Get Transform
Get a specific transform.
Get Transform Dependencies
Get the dependencies of a specific transform.
Get Transform Inspection Lens
Phase 2 - Get full lens contents for a transform.
Get Transform Run
Get a transform run by ID.
Inspect Transform
Phase 1 - Discover available lenses for a transform.
Create Transform
Create a new transform.
Update Transform
Update a transform.
Cancel Transform
Cancel the current run for a given transform.
Query Transform Inspection Lens
Execute a query in the context of a transform inspector lens.
Reset Transform Checkpoint
Reset the stored checkpoint for an incremental transform.
Run Transform
Run a transform.
Run Transform DAG
Trigger a DAG-reprocess run starting from a single transform - runs the transform and every transform in its transitive…
Delete Transform
Delete a transform.
Delete Transform Table
Delete a transform’s output table.
List Transform Tags
Get a list of all transform tags.
Create Transform Tag
Create a new transform tag.
Update Transform Tag
Update a transform tag.
Delete Transform Tag
Delete a transform tag.
List Users
List people in a Metabase instance, with their group ids.
Get User
Get a Metabase person by ID, with their group memberships.
Get Current User
Get the Metabase user the API key acts as.
List User Recipients
Fetch a list of Users.
Create User
Create a new User, return a 400 if the email address is already taken.
Create User Password Reset Url
Generate a password reset URL for a user.
Reactivate User
Reactivate user at id.
Update User
Update an existing, active User.
Update User Password
Update a user’s password.
Disable User
Disable a User.

Events

|
1 event
Event
Description
Tags
Alert Sent
Processes Metabase alert deliveries sent to a webhook.
WebhooksAlerts