- Returns the actions the current user can read, unarchived unless ?archived=true.
- Fetch a list of Actions with public UUIDs.
- Fetch an Action.
- Create a new action.
- Generate publicly-accessible links for this Action.
- Update an Action.
- Execute the Action.
- Fetches the values for filling in execution parameters.
- Delete an Action.
- Delete the publicly-accessible link to this Dashboard.
- Get the list of 5 popular things on the instance.
- Get a list of recent items the current user has been viewing most recently under the recents key.
- Get the most recently viewed dashboard for the current user.
- Fetch alerts which the current user has created or will receive, or all alerts if the user is an admin.
- Fetch an alert by ID.
- List the API keys in a Metabase instance, with the group each key belongs to.
- Get the count of API keys in the DB with the default scope.
- Create a new API key (and an associated User) with the provided name and group ID.
- Regenerate an API Key.
- Update an API key by changing its group and/or its name.
- Delete an ApiKey.
- Fetch all bookmarks for the user.
- Create a new bookmark for user.
- Sets the order of bookmarks for user.
- Delete a bookmark.
- Return cache configuration.
- Store cache configuration.
- Invalidate cache entries.
- Delete cache configurations.
- Get a list of {:name ...
- Fetches a list of compatible series with the card with id card_id.; last_cursor with value is the id of the last card from the previous page to fetch the next page.; query to search card by name.; exclude_ids to filter out a list of card ids.
- Get all the Cards.
- Fetch a list of Cards where enable_embedding is true.
- Fetch a list of Cards with public UUIDs.
- Fetch possible values of the parameter whose ID is param-key that contain query.
- Get Card with ID.
- Fetch the remapped value for a given value of the parameter with ID param-key.
- Fetch possible values of the parameter whose ID is param-key.
- Get all of the required query metadata for a card.
- Create a new Card.
- Generate publicly-accessible links for this Card.
- Update a Card.
- Copy a Card, with the new name 'Copy of _name_'.
- Run the query associated with a Card, and return its results as a file in the specified format.
- Get the dashboards that multiple cards appear in.
- Moves a number of Cards to a single collection or dashboard.
- Bulk update endpoint for Card Collections.
- Run the query associated with a Card.
- Run the query associated with a Card.
- Hard delete a Card.
- Delete the publicly-accessible link to this Card.
- Get all channels.
- Get a channel.
- Create a channel.
- Update a channel.
- Test a channel connection.
- Find cards in this collection that can be moved into dashboards in this collection.
- Fetch a specific Collection's items with the following options - models - only include objects of a specific set of models.
- Fetch a list of all Collections that the current user has read permissions for (can_write is returned as an additional property of each Collection so you can tell which of these you have write permissions for.) By default, this returns non-archived Collections, but instead you can show archived ones by passing ?archived=true.
- Fetch objects that the current user should see at their root level.
- Find cards in the root collection that can be moved into dashboards in the root collection.
- Fetch a specific Collection with standard details added.
- Metadata about the collection's items list - the models with at least one visible item plus the item count.
- Fetch a graph of all Collection Permissions.
- Return the 'Root' Collection object with standard details added.
- Fetch the trash collection, as in /api/collection/:trash-id.
- Similar to GET /, but returns Collections in a tree structure, e.g.
- Metadata about the Root Collection's items list - the models with at least one visible item plus the item count.
- Create a new Collection.
- Modify an existing Collection, including archiving or unarchiving it, or moving it.
- Do a batch update of Collections Permissions by passing in a modified graph.
- Move candidate cards to the dashboards they appear in.
- Move candidate cards to the dashboards they appear in (for the root collection)
- Deletes a collection permanently. It must be in the trash first (update_collection with archived true); otherwise Metabase returns 400.
- Get comments for an entity.
- Get a list of entities suitable for mentions.
- Create a new comment.
- Update a comment.
- Toggle a reaction on a comment.
- Soft delete a comment.
- Get Dashboard with ID.
- Fetch a list of Dashboards where enable_embedding is true.
- Fetch a list of Dashboards with public UUIDs.
- Utility endpoint for powering Dashboard UI.
- Fetch possible values of the parameter whose ID is param-key that contain query.
- Get Dashboard with ID.
- Fetch the remapped value for a given value of the parameter with ID param-key.
- Fetch possible values of the parameter whose ID is param-key.
- Get all of the required query metadata for the cards on dashboard.
- Return related entities.
- Create a new Dashboard.
- Generate publicly-accessible links for this Dashboard.
- Update a Dashboard, and optionally the dashcards and tabs of a Dashboard.
- Copy a Dashboard.
- Execute the associated Action in the context of a Dashboard and DashboardCard that includes it.
- Render Dashboard with ID to a PDF (server-side, the same way dashboard subscriptions render charts) and stream it back as a file download.
- Run the query associated with a Saved Question (Card) in the context of a Dashboard that includes it, and return its results as a file in the specified format.
- Fetches the values for filling in execution parameters.
- Run the query associated with a Saved Question (Card) in the context of a Dashboard that includes it.
- Run a pivot table query for a specific DashCard.
- Save a denormalized description of dashboard.
- Save a denormalized description of dashboard into collection with ID parent-collection-id.
- Hard delete a Dashboard.
- Delete the publicly-accessible link to this Dashboard.
- Get a list of all Fields in Database.
- Get a list of all primary key Fields for Database.
- Returns a list of Tables for the given Database id and schema.
- Return a list of Tables for a Database whose schema is the schema query parameter, or nil or an empty string when no schema is given.
- Returns a list of all the schemas with tables found for the database id.
- Returns a list of all syncable schemas found for the database id.
- Fetch all Databases.; include=tables means we should hydrate the Tables belonging to each DB.
- Returns a list of all the datasets found for the saved questions virtual database.
- Returns a list of Tables for the datasets virtual database.
- Returns a list of Tables for the saved questions virtual database.
- Returns a list of all the schemas found for the saved questions virtual database.
- Get a single Database with id.
- Return a list of autocomplete suggestions for a given prefix, or substring.
- Return a list of Card autocomplete suggestions for a given query in a given Database.
- Reports whether the database can currently connect.
- Get metadata about a Database, including all of its Tables and Fields.
- Get all database-local settings and their availability for the given database.
- Get usage info for a database.
- Endpoint that provides metadata for the Saved Questions 'virtual' database.
- Add a new Database.
- Update a Database.
- Add the sample database as a new Database.
- Discards all saved field values for this Database.
- Trigger a manual scan of the field values for this Database.
- Trigger a manual update of the schema metadata for this Database.
- Validate that we can connect to a database given a set of details.
- Delete a Database.
- Return parameter values for cards or dashboards that are being edited.
- Execute a query and download the result data as a file in the specified format.
- Return the remapped parameter values for cards or dashboards that are being edited.
- Return parameter values for cards or dashboards that are being edited.
- Get all of the required query metadata for an ad-hoc query.
- Fetch a native version of an MBQL query.
- Execute a query and retrieve the results in the usual format.
- Generate a pivoted dataset for an ad-hoc query.
- Gets existing Documents.
- List all Documents that have public links.
- Returns an existing Document by ID.
- Create a new Document.
- Generate a publicly-accessible UUID for a Document.
- Updates an existing Document.
- Copy a Document.
- Download query results for a Card embedded in a Document.
- Permanently deletes a document. It must be archived first (update_document with archived true); otherwise Metabase returns 400.
- Remove the public link for a Document.
- Search a field's values for text.
- Get Field with ID.
- Return related entities.
- Fetch remapped Field values.
- Get the count and distinct count of Field with ID.
- 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), and (if defined by a User) a map of human-readable remapped values.
- Sets the dimension for the given field at ID.
- Update Field with ID.
- Update the fields values and human-readable values for a Field whose semantic type is category/city/state/country or whose base type is type/Boolean.
- Discard the FieldValues belonging to this Field.
- Get unique Table IDs for a list of Field IDs.
- Manually trigger an update for the FieldValues for this Field.
- Remove the dimension associated to field at ID.
- Fetch all glossary entries, optionally filtered by search term.
- Create a new glossary entry.
- Update an existing glossary entry.
- Delete a glossary entry.
- List the permission groups in a Metabase instance, with member counts.
- Get a Metabase permission group by ID, with its members.
- List the group memberships in a Metabase instance, keyed by user id.
- IDs of the permission groups holding a stored read (or read-write) grant on the collection of a shareable item (a dashboard or a question).
- Create a new PermissionsGroup.
- Add a User to a PermissionsGroup.
- Remove all members from a PermissionsGroup.
- Update the name of a PermissionsGroup.
- Update a Permission Group membership.
- Delete a specific PermissionsGroup.
- Remove a User from a PermissionsGroup (delete their membership).
- Get the current Metabase connection's unified credentials and identity.
- List unified permission groups in a Metabase instance.
- Get a unified Metabase permission group by ID.
- List unified roles in Metabase.
- Get a unified Metabase role by ID.
- List unified users in a Metabase instance.
- Get a unified Metabase user by ID.
- Fetch recent logins for the current user.
- Fetch *all* Measures.
- Search for values of a dimension that contain the query string.
- Fetch Measure with ID.
- Fetch remapped value for a specific dimension value.
- Fetch values for a dimension of a measure.
- Create a new Measure.
- Update a Measure with ID.
- List a metric's curated dimensions, and (when with-addable=true) the columns still available to add, grouped by source table.
- Get a list of metrics.
- Search for values of a dimension that contain the query string.
- Fetch a Metric with ID.
- Fetch remapped value for a specific dimension value.
- Fetch values for a dimension of a metric.
- Update a metric dimension's display_name, description, default_temporal_unit, and/or source column.
- Add dimensions to a metric.
- Fetch distinct breakout dimension values for a metric or measure definition.
- Remove dimensions (by UUID) from a metric.
- Persist a new ordering for a metric's dimensions.
- Execute a metric or measure-based query and stream the results.
- Mark exactly one dimension as the metric's default, clearing any previous default.
- Retrieve list of ModelIndex.
- Retrieve ModelIndex.
- Create ModelIndex.
- Delete ModelIndex.
- Create a new ModerationReview.
- List card-type notifications (alerts) for admin management.
- List notifications.; creator_id - if provided returns only notifications created by this user; recipient_id - if provided returns only notification that has recipient_id as a recipient; creator_or_recipient_id - if provided returns only notification that has user_id as creator or recipient; card_id - if provided returns only notification that has card_id as payload.
- Get a single card-type notification with last_check, last_send, check_history (up to 10 most-recent terminal alert-type TaskRuns) and send_history (up to 10 most-recent channel-send delivery attempts).
- Get a notification by id.
- Create a new notification, return the created notification.
- Update a notification, can also update its subscriptions, handlers.
- Bulk-archive or -change-creator a set of notifications.
- Send a notification by id.
- Send an unsaved notification.
- Fetch a graph of all Permissions for db-id db-id.
- Fetch a graph of all Permissions for group-id group-id.
- Fetch a graph of all Permissions.
- Do a batch update of Permissions by passing in a modified graph.
- List the entries of PersistedInfo in order to show a status page.
- Fetch a particular PersistedInfo by card-id.
- Fetch a particular PersistedInfo by id.
- Disable global setting to allow databases to persist models.
- Enable global setting to allow databases to persist models.
- Mark the model (card) as persisted.
- Attempt to enable model persistence for a database.
- Refresh the persisted model caching card-id.
- Set the cron schedule to refresh persisted models.
- Unpersist this model.
- Attempt to disable model persistence for a database.
- Fetch all dashboard subscriptions.
- Fetch Pulse with ID.
- Provides relevant configuration information and user choices for creating/updating Pulses.
- Create a new Pulse.
- Update a Pulse with id.
- Test send an unsaved pulse.
- Fetch Revisions for an object with ID.
- Get revisions of an object.
- Revert an object to a prior revision.
- Search for items in Metabase.
- Return the current weights being used to rank the search results.
- Update the current weights being used to rank the search results.
- This will trigger an immediate reindexing, if we are using search index.
- This will blow away any search indexes, re-create, and re-populate them.
- Fetch *all* Segments.
- Fetch Segment with ID.
- Return related entities.
- Create a new Segment.
- Update a Segment with ID.
- Get all Settings and their values.
- Fetch a single Setting.
- Create/update a Setting.
- Update multiple Settings values.
- Fetch all snippets.
- Fetch native query snippet with ID.
- Create a new NativeQuerySnippet.
- Update an existing NativeQuerySnippet.
- Get all foreign keys whose destination is a Field that belongs to this Table.
- Get all Tables.
- Return metadata for the 'virtual' table for a Card.
- Get Table with ID.
- Get the data for the given table.
- Get metadata about a Table useful for running queries.
- Return related entities.
- Reorder fields.
- Update Table with ID.
- Inserts the rows of an uploaded CSV file into the table identified by id.
- Discard the FieldValues belonging to the Fields in this Table.
- Replaces the contents of the table identified by id with the rows of an uploaded CSV file.
- Manually trigger an update for the FieldValues for the Fields belonging to this Table.
- Trigger a manual update of the schema metadata for this Table.
- Create a table and model populated with the values from the attached CSV.
- Get distinct entities that have task runs for a given run type.
- List task runs with optional filters.
- Fetch a list of recent tasks stored as Task History.
- Returns possibly empty vector of unique task names in alphabetical order.
- Get TaskHistory entry with ID.
- Return raw data about all scheduled tasks (i.e., Quartz Jobs and Triggers).
- Get a single task run with all its child tasks.
- Fetch the TimelineEvent with id.
- Create a new TimelineEvent.
- Update a TimelineEvent.
- Delete a TimelineEvent.
- Fetch a specific Collection's timelines.
- Fetch the root Collection's timelines.
- Fetch a list of Timelines.
- Fetch the Timeline with id.
- Create a new Timeline.
- Update the Timeline with id.
- Delete a Timeline.
- Get the transform runs that made up a specific job run.
- Get paginated run history for a transform job.
- Get the transforms of job specified by the job's ID.
- Get all transform jobs.
- Get a transform job by ID.
- Create a new transform job.
- Activate or deactivate every transform job.
- Update a transform job.
- Cancel an in-progress job run and request cancellation of its still-running transforms.
- Run a transform job manually.
- Delete a transform job.
- Preview the transforms a DAG reprocess from this transform would run (see POST /:id/run-dag), in execution order.
- Paginated unified run history - every row is a root run — a job run, a manual DAG-reprocess run, or a standalone transform run — never a member run of a job/DAG (those are listed by GET /run and the per-run transform-runs endpoints).
- Get a list of transforms.
- Get transform runs based on a set of filter params.
- Get a specific transform.
- Get the dependencies of a specific transform.
- Phase 2 - Get full lens contents for a transform.
- Get a transform run by ID.
- Phase 1 - Discover available lenses for a transform.
- Create a new transform.
- Update a transform.
- Cancel the current run for a given transform.
- Execute a query in the context of a transform inspector lens.
- Reset the stored checkpoint for an incremental transform.
- Run a transform.
- Trigger a DAG-reprocess run starting from a single transform - runs the transform and every transform in its transitive dependency closure.
- Delete a transform.
- Delete a transform's output table.
- Get a list of all transform tags.
- Create a new transform tag.
- Update a transform tag.
- Delete a transform tag.
- List people in a Metabase instance, with their group ids.
- Get a Metabase person by ID, with their group memberships.
- Get the Metabase user the API key acts as.
- Fetch a list of Users.
- Create a new User, return a 400 if the email address is already taken.
- Generate a password reset URL for a user.
- Reactivate user at id.
- Update an existing, active User.
- Update a user's password.
- Disable a User.
No matching actions