Get recent activity.

Get the list of 10 things the current user has been viewing most recently.

Delete an Alert. (DEPRECATED -- don't delete a Alert anymore -- archive it instead.)

• id

Fetch all alerts

• archived value may be nil, or if non-nil, value must be a valid boolean string ('true' or 'false').

Fetch all questions for the given question (Card) id

• id

Create a new Alert.

• alert_condition value must be one of: goal, rows.

• card value must be a map with the keys id, include_csv, and include_xls.

• channels value must be an array. Each value must be a map. The array cannot be empty.

• alert_first_only value must be a boolean.

• alert_above_goal value may be nil, or if non-nil, value must be a boolean.

• new-alert-request-body

Update a Alert with ID.

• id

• alert_condition value may be nil, or if non-nil, value must be one of: goal, rows.

• card value may be nil, or if non-nil, value must be a map with the keys id, include_csv, and include_xls.

• channels value may be nil, or if non-nil, value must be an array. Each value must be a map. The array cannot be empty.

• alert_first_only value may be nil, or if non-nil, value must be a boolean.

• alert_above_goal value may be nil, or if non-nil, value must be a boolean.

• archived value may be nil, or if non-nil, value must be a boolean.

• alert-updates

Unsubscribes a user from the given alert

• id

Return an automagic dashboard for entity entity with id ìd.

• entity Invalid entity type

• entity-id-or-query

• show invalid show value

Return an automagic dashboard analyzing cell in automagic dashboard for entity entity defined by query cell-querry.

• entity Invalid entity type

• entity-id-or-query

• cell-query value couldn't be parsed as base64 encoded JSON

• show invalid show value

Return an automagic comparison dashboard for cell in automagic dashboard for entity entity with id ìd defined by query cell-querry; compared with entity comparison-entity with id comparison-entity-id-or-query..

• entity Invalid entity type

• entity-id-or-query

• cell-query value couldn't be parsed as base64 encoded JSON

• show invalid show value

• comparison-entity Invalid comparison entity type. Can only be one of "table", "segment", or "adhoc"

• comparison-entity-id-or-query

Return an automagic dashboard analyzing cell in question with id id defined by query cell-querry using rule rule.

• entity Invalid entity type

• entity-id-or-query

• cell-query value couldn't be parsed as base64 encoded JSON

• prefix invalid value for prefix

• rule invalid value for rule name

• show invalid show value

Return an automagic comparison dashboard for cell in automagic dashboard for entity entity with id ìd defined by query cell-querry using rule rule; compared with entity comparison-entity with id comparison-entity-id-or-query..

• entity Invalid entity type

• entity-id-or-query

• cell-query value couldn't be parsed as base64 encoded JSON

• prefix invalid value for prefix

• rule invalid value for rule name

• show invalid show value

• comparison-entity Invalid comparison entity type. Can only be one of "table", "segment", or "adhoc"

• comparison-entity-id-or-query

Return an automagic comparison dashboard for entity entity with id ìd compared with entity comparison-entity with id comparison-entity-id-or-query.

• entity Invalid entity type

• entity-id-or-query

• show invalid show value

• comparison-entity Invalid comparison entity type. Can only be one of "table", "segment", or "adhoc"

• comparison-entity-id-or-query

Return an automagic dashboard for entity entity with id ìd using rule rule.

• entity Invalid entity type

• entity-id-or-query

• prefix invalid value for prefix

• rule invalid value for rule name

• show invalid show value

Return an automagic comparison dashboard for entity entity with id ìd using rule rule; compared with entity comparison-entity with id comparison-entity-id-or-query..

• entity Invalid entity type

• entity-id-or-query

• prefix invalid value for prefix

• rule invalid value for rule name

• show invalid show value

• comparison-entity Invalid comparison entity type. Can only be one of "table", "segment", or "adhoc"

• comparison-entity-id-or-query

Return a list of candidates for automagic dashboards orderd by interestingness.

• id

Unfavorite a Card.

• card-id

Delete the publicly-accessible link to this Card.

You must be a superuser to do this.

• card-id

Delete a Card. (DEPRECATED -- don't delete a Card anymore -- archive it instead.)

• id

Get all the Cards. Option filter param f can be used to change the set of Cards that are returned; default is all, but other options include mine, fav, database, table, recent, popular, and archived. See corresponding implementation functions above for the specific behavior of each filter option. 📇

• f value may be nil, or if non-nil, value must be one of: all, archived, database, fav, mine, popular, recent, table.

• model_id value may be nil, or if non-nil, value must be an integer greater than zero.

Get Card with ID.

• id

Return related entities.

• id

Fetch a list of Cards where enable_embedding is true. The cards can be embedded using the embedding endpoints and a signed JWT.

You must be a superuser to do this.

Fetch a list of Cards with public UUIDs. These cards are publicly-accessible if public sharing is enabled.

You must be a superuser to do this.

Create a new Card.

• visualization_settings value must be a map.

• description value may be nil, or if non-nil, value must be a non-blank string.

• collection_position value may be nil, or if non-nil, value must be an integer greater than zero.

• result_metadata value may be nil, or if non-nil, value must be an array of valid results column metadata maps.

• metadata_checksum value may be nil, or if non-nil, value must be a non-blank string.

• collection_id value may be nil, or if non-nil, value must be an integer greater than zero.

• name value must be a non-blank string.

• dataset_query

• display value must be a non-blank string.

Favorite a Card.

• card-id

Generate publicly-accessible links for this Card. Returns UUID to be used in public links. (If this Card has already been shared, it will return the existing public link rather than creating a new one.) Public sharing must be enabled.

You must be a superuser to do this.

• card-id

Run the query associated with a Card.

• card-id

• parameters

• ignore_cache value may be nil, or if non-nil, value must be a boolean.

Run the query associated with a Card, and return its results as a file in the specified format. Note that this expects the parameters as serialized JSON in the 'parameters' parameter

• card-id

• export-format value must be one of: csv, json, xlsx.

• parameters value may be nil, or if non-nil, value must be a valid JSON string.

• respond

• raise

Bulk update endpoint for Card Collections. Move a set of Cards with CARD_IDS into a Collection with COLLECTION_ID, or remove them from any Collections by passing a null COLLECTION_ID.

• card_ids value must be an array. Each value must be an integer greater than zero.

• collection_id value may be nil, or if non-nil, value must be an integer greater than zero.

Return related entities for an ad-hoc query.

• query

Update a Card.

• visualization_settings value may be nil, or if non-nil, value must be a map.

• description value may be nil, or if non-nil, value must be a string.

• archived value may be nil, or if non-nil, value must be a boolean.

• collection_position value may be nil, or if non-nil, value must be an integer greater than zero.

• result_metadata value may be nil, or if non-nil, value must be an array of valid results column metadata maps.

• metadata_checksum value may be nil, or if non-nil, value must be a non-blank string.

• enable_embedding value may be nil, or if non-nil, value must be a boolean.

• collection_id value may be nil, or if non-nil, value must be an integer greater than zero.

• card-updates

• name value may be nil, or if non-nil, value must be a non-blank string.

• embedding_params value may be nil, or if non-nil, value must be a valid embedding params map.

• dataset_query value may be nil, or if non-nil, value must be a map.

• id

• display value may be nil, or if non-nil, value must be a non-blank string.

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.

• archived value may be nil, or if non-nil, value must be a valid boolean string ('true' or 'false').

Fetch a specific Collection with standard details added

• id

Fetch a specific Collection's items with the following options:

• model - only include objects of a specific model. If unspecified, returns objects of all models
• archived - when true, return archived objects instead of unarchived ones. Defaults to false.

• id

• model value may be nil, or if non-nil, value must be one of: card, collection, dashboard, pulse.

• archived value may be nil, or if non-nil, value must be a valid boolean string ('true' or 'false').

Fetch a graph of all Collection Permissions.

You must be a superuser to do this.

Return the 'Root' Collection object with standard details added

Fetch objects that the current user should see at their root level. As mentioned elsewhere, the 'Root' Collection doesn't actually exist as a row in the application DB: it's simply a virtual Collection where things with no collection_id exist. It does, however, have its own set of Permissions.

This endpoint will actually show objects with no collection_id for Users that have Root Collection permissions, but for people without Root Collection perms, we'll just show the objects that have an effective location of /.

This endpoint is intended to power a 'Root Folder View' for the Current User, so regardless you'll see all the top-level objects you're allowed to access.

• model value may be nil, or if non-nil, value must be one of: card, collection, dashboard, pulse.

• archived value may be nil, or if non-nil, value must be a valid boolean string ('true' or 'false').

Create a new Collection.

• name value must be a non-blank string.

• color value must be a string that matches the regex ^#[0-9A-Fa-f]{6}$.

• description value may be nil, or if non-nil, value must be a non-blank string.

• parent_id value may be nil, or if non-nil, value must be an integer greater than zero.

Modify an existing Collection, including archiving or unarchiving it, or moving it.

• id

• name value may be nil, or if non-nil, value must be a non-blank string.

• color value may be nil, or if non-nil, value must be a string that matches the regex ^#[0-9A-Fa-f]{6}$.

• description value may be nil, or if non-nil, value must be a non-blank string.

• archived value may be nil, or if non-nil, value must be a boolean.

• parent_id value may be nil, or if non-nil, value must be an integer greater than zero.

• collection-updates

Do a batch update of Collections Permissions by passing in a modified graph.

You must be a superuser to do this.

• body value must be a map.

Delete the publicly-accessible link to this Dashboard.

You must be a superuser to do this.

• dashboard-id

Delete a Dashboard.

• id

Remove a DashboardCard from a Dashboard.

• id

• dashcardId value must be a valid integer greater than zero.

Unfavorite a Dashboard.

• id

Get Dashboards. With filter option f (default all), restrict results as follows:

• all - Return all Dashboards.
• mine - Return Dashboards created by the current user.
• archived - Return Dashboards that have been archived. (By default, these are excluded.)

• f value may be nil, or if non-nil, value must be one of: all, archived, mine.

Get Dashboard with id.

• id

Return related entities.

• id

Fetch Revisions for Dashboard with id.

• id

Fetch a list of Dashboards where enable_embedding is true. The dashboards can be embedded using the embedding endpoints and a signed JWT.

You must be a superuser to do this.

Fetch a list of Dashboards with public UUIDs. These dashboards are publicly-accessible if public sharing is enabled.

You must be a superuser to do this.

Create a new Dashboard.

• name value must be a non-blank string.

• description value may be nil, or if non-nil, value must be a string.

• parameters value must be an array. Each value must be a map.

• collection_id value may be nil, or if non-nil, value must be an integer greater than zero.

• collection_position value may be nil, or if non-nil, value must be an integer greater than zero.

• dashboard

Generate publicly-accessible links for this Dashboard. Returns UUID to be used in public links. (If this Dashboard has already been shared, it will return the existing public link rather than creating a new one.) Public sharing must be enabled.

You must be a superuser to do this.

• dashboard-id

Copy a Dashboard.

• from-dashboard-id

• name value may be nil, or if non-nil, value must be a non-blank string.

• description value may be nil, or if non-nil, value must be a string.

• collection_id value may be nil, or if non-nil, value must be an integer greater than zero.

• collection_position value may be nil, or if non-nil, value must be an integer greater than zero.

• dashboard

Add a Card to a Dashboard.

• id

• cardId value may be nil, or if non-nil, value must be an integer greater than zero.

• parameter_mappings value must be an array. Each value must be a map.

• series

• dashboard-card

Favorite a Dashboard.

• id

Revert a Dashboard to a prior Revision.

• id

• revision_id value must be an integer greater than zero.

Save a denormalized description of dashboard.

• dashboard

Save a denormalized description of dashboard into collection with ID :parent-collection-id.

• parent-collection-id

• dashboard

Update a Dashboard.

Usually, you just need write permissions for this Dashboard to do this (which means you have appropriate permissions for the Cards belonging to this Dashboard), but to change the value of enable_embedding you must be a superuser.

• parameters value may be nil, or if non-nil, value must be an array. Each value must be a map.

• points_of_interest value may be nil, or if non-nil, value must be a string.

• description value may be nil, or if non-nil, value must be a string.

• archived value may be nil, or if non-nil, value must be a boolean.

• collection_position value may be nil, or if non-nil, value must be an integer greater than zero.

• show_in_getting_started value may be nil, or if non-nil, value must be a boolean.

• enable_embedding value may be nil, or if non-nil, value must be a boolean.

• collection_id value may be nil, or if non-nil, value must be an integer greater than zero.

• dash-updates

• name value may be nil, or if non-nil, value must be a non-blank string.

• caveats value may be nil, or if non-nil, value must be a string.

• embedding_params value may be nil, or if non-nil, value must be a valid embedding params map.

• id

• position value may be nil, or if non-nil, value must be an integer greater than zero.

Update Cards on a Dashboard. Request body should have the form:

{:cards [{:id     ...
          :sizeX  ...
          :sizeY  ...
          :row    ...
          :col    ...
          :series [{:id 123
                    ...}]} ...]}

• id

• cards

Delete a Database.

• id

Fetch all Databases. include_tables means we should hydrate the Tables belonging to each DB. include_cards here means we should also include virtual Table entries for saved Questions, e.g. so we can easily use them as source Tables in queries. Default for both is false.

• include_tables value may be nil, or if non-nil, value must be a valid boolean string ('true' or 'false').

• include_cards value may be nil, or if non-nil, value must be a valid boolean string ('true' or 'false').

Get Database with ID.

• id

Return a list of autocomplete suggestions for a given PREFIX. This is intened for use with the ACE Editor when the User is typing raw SQL. Suggestions include matching Tables and Fields in this Database.

Tables are returned in the format [table_name "Table"]; Fields are returned in the format [field_name "table_name base_type special_type"]

• id

• prefix value must be a non-blank string.

Get a list of all Fields in Database.

• id

Get a list of all primary key Fields for Database.

• id

Get metadata about a Database, including all of its Tables and Fields. Returns DB, fields, and field values.

• id

Returns a list of tables for the given database id and schema

• id

• schema

Returns a list of all the schemas found for the database id

• id

Endpoint that provides metadata for the Saved Questions 'virtual' database. Used for fooling the frontend and allowing it to treat the Saved Questions virtual DB just like any other database.

Add a new Database.

You must be a superuser to do this.

• name value must be a non-blank string.

• engine value must be a valid database engine.

• details value must be a map.

• is_full_sync value may be nil, or if non-nil, value must be a boolean.

• is_on_demand value may be nil, or if non-nil, value must be a boolean.

• schedules value may be nil, or if non-nil, value must be a valid map of schedule maps for a DB.

Discards all saved field values for this Database.

You must be a superuser to do this.

• id

Trigger a manual scan of the field values for this Database.

You must be a superuser to do this.

• id

Update the metadata for this Database. This happens asynchronously.

• id

Trigger a manual update of the schema metadata for this Database.

You must be a superuser to do this.

• id

Add the sample dataset as a new Database.

You must be a superuser to do this.

Validate that we can connect to a database given a set of details.

You must be a superuser to do this.

• engine value must be a valid database engine.

• details value must be a map.

Update a Database.

You must be a superuser to do this.

• engine value may be nil, or if non-nil, value must be a valid database engine.

• schedules value may be nil, or if non-nil, value must be a valid map of schedule maps for a DB.

• points_of_interest value may be nil, or if non-nil, value must be a string.

• description value may be nil, or if non-nil, value must be a string.

• name value may be nil, or if non-nil, value must be a non-blank string.

• caveats value may be nil, or if non-nil, value must be a string.

• is_full_sync

• details value may be nil, or if non-nil, value must be a map.

• id

• is_on_demand

Execute a query and retrieve the results in the usual format.

• database value must be an integer.

• query

Execute a query and download the result data as a file in the specified format.

• export-format value must be one of: csv, json, xlsx.

• query value must be a valid JSON string.

• respond

• raise

Get historical query execution duration.

• database

• query

Clear all email related settings. You must be a superuser to ddo this

You must be a superuser to do this.

Send a test email. You must be a superuser to do this.

You must be a superuser to do this.

Update multiple email Settings. You must be a superuser to do this.

You must be a superuser to do this.

• settings value must be a map.

Fetch a Card via a JSON Web Token signed with the embedding-secret-key.

Token should have the following format:

 {:resource {:question <card-id>}}

• token

Fetch remapped Field values. This is the same as GET /api/field/:id/remapping/:remapped-id, but for use with embedded Cards.

• token

• field-id

• remapped-id

• value value must be a non-blank string.

Search for values of a Field that is referenced by an embedded Card.

• token

• field-id

• search-field-id

• value value must be a non-blank string.

• limit value may be nil, or if non-nil, value must be a valid integer greater than zero.

Fetch FieldValues for a Field that is referenced by an embedded Card.

• token

• field-id

Fetch the results of running a Card using a JSON Web Token signed with the embedding-secret-key.

Token should have the following format:

 {:resource {:question <card-id>}
  :params   <parameters>}

• token

• &

• query-params

Like GET /api/embed/card/query, but returns the results as a file in the specified format.

• token

• export-format value must be one of: csv, json, xlsx.

• query-params

• respond

• raise

Fetch a Dashboard via a JSON Web Token signed with the embedding-secret-key.

Token should have the following format:

 {:resource {:dashboard <dashboard-id>}}

• token

Fetch the results of running a Card belonging to a Dashboard using a JSON Web Token signed with the embedding-secret-key

• token

• dashcard-id

• card-id

• &

• query-params

Fetch the results of running a Card belonging to a Dashboard using a JSON Web Token signed with the embedding-secret-key return the data in one of the export formats

• token

• export-format value must be one of: csv, json, xlsx.

• dashcard-id

• card-id

• query-params

• respond

• raise

Fetch remapped Field values. This is the same as GET /api/field/:id/remapping/:remapped-id, but for use with embedded Dashboards.

• token

• field-id

• remapped-id

• value value must be a non-blank string.

Search for values of a Field that is referenced by a Card in an embedded Dashboard.

• token

• field-id

• search-field-id

• value value must be a non-blank string.

• limit value may be nil, or if non-nil, value must be a valid integer greater than zero.

Fetch FieldValues for a Field that is used as a param in an embedded Dashboard.

• token

• field-id

Remove the dimension associated to field at ID

• id

Get Field with ID.

• id

Return related entities.

• id

Fetch remapped Field values.

• id

• remapped-id

• value

Search for values of a Field with search-id that start with value. See docstring for metabase.api.field/search-values for a more detailed explanation.

• id

• search-id

• value value must be a non-blank string.

• limit value may be nil, or if non-nil, value must be a valid integer greater than zero.

Get the count and distinct count of Field with ID.

• id

If a Field's value of has_field_values is list, return a list of all the distinct values of the Field, and (if defined by a User) a map of human-readable remapped values.

• id

Implementation of the field values endpoint for fields in the Saved Questions 'virtual' DB. This endpoint is just a convenience to simplify the frontend code. It just returns the standard 'empty' field values response.

• _

Sets the dimension for the given field at ID

• id

• type value must be one of: external, internal.

• name value must be a non-blank string.

• human_readable_field_id value may be nil, or if non-nil, value must be an integer greater than zero.

Discard the FieldValues belonging to this Field. Only applies to fields that have FieldValues. If this Field's Database is set up to automatically sync FieldValues, they will be recreated during the next cycle.

You must be a superuser to do this.

• id

Manually trigger an update for the FieldValues for this Field. Only applies to Fields that are eligible for FieldValues.

You must be a superuser to do this.

• id

Update the fields values and human-readable values for a Field whose special type is category/city/state/country or whose base type is type/Boolean. The human-readable values are optional.

• id

• value-pairs value must be an array. Each value must be an array.

Update Field with ID.

• visibility_type value may be nil, or if non-nil, value must be one of: details-only, hidden, normal, retired, sensitive.

• display_name value may be nil, or if non-nil, value must be a non-blank string.

• points_of_interest value may be nil, or if non-nil, value must be a non-blank string.

• description value may be nil, or if non-nil, value must be a non-blank string.

• special_type value may be nil, or if non-nil, value must be a valid field type.

• has_field_values value may be nil, or if non-nil, value must be one of: auto-list, list, none, search.

• settings value may be nil, or if non-nil, value must be a map.

• caveats value may be nil, or if non-nil, value must be a non-blank string.

• fk_target_field_id value may be nil, or if non-nil, value must be an integer greater than zero.

• id

Fetch a custom GeoJSON file as defined in the custom-geojson setting. (This just acts as a simple proxy for the file specified for KEY).

• key value must be a non-blank string.

Update LDAP related settings. You must be a superuser to do this.

You must be a superuser to do this.

• settings value must be a map.

Archive a Metric. (DEPRECATED -- Just pass updated value of :archived to the PUT endpoint instead.)

• id

• revision_message value must be a non-blank string.

Fetch all Metrics.

• id

Fetch Metric with ID.

• id

Return related entities.

• id

Fetch Revisions for Metric with ID.

• id

Create a new Metric.

• name value must be a non-blank string.

• description value may be nil, or if non-nil, value must be a string.

• table_id value must be an integer greater than zero.

• definition value must be a map.

Revert a Metric to a prior Revision.

• id

• revision_id value must be an integer greater than zero.

Update a Metric with ID.

• points_of_interest value may be nil, or if non-nil, value must be a string.

• description value may be nil, or if non-nil, value must be a string.

• archived value may be nil, or if non-nil, value must be a boolean.

• definition value may be nil, or if non-nil, value must be a map.

• revision_message value must be a non-blank string.

• show_in_getting_started value may be nil, or if non-nil, value must be a boolean.

• name value may be nil, or if non-nil, value must be a non-blank string.

• caveats value may be nil, or if non-nil, value must be a string.

• id

• how_is_this_calculated value may be nil, or if non-nil, value must be a string.

Update the important Fields for a Metric with ID. (This is used for the Getting Started guide).

You must be a superuser to do this.

• id

• important_field_ids value must be an array. Each value must be an integer greater than zero.

Notification about a potential schema change to one of our Databases. Caller can optionally specify a :table_id or :table_name in the body to limit updates to a single Table.

• id

• table_id

• table_name

Delete a specific PermissionsGroup.

You must be a superuser to do this.

• group-id

Remove a User from a PermissionsGroup (delete their membership).

You must be a superuser to do this.

• id

Fetch a graph of all Permissions.

You must be a superuser to do this.

Fetch all PermissionsGroups, including a count of the number of :members in that group.

You must be a superuser to do this.

Fetch the details for a certain permissions group.

You must be a superuser to do this.

• id

Fetch a map describing the group memberships of various users. This map's format is:

{<user-id> [{:membership_id <id>
             :group_id      <id>}]}

You must be a superuser to do this.

Create a new PermissionsGroup.

You must be a superuser to do this.

• name value must be a non-blank string.

Add a User to a PermissionsGroup. Returns updated list of members belonging to the group.

You must be a superuser to do this.

• group_id value must be an integer greater than zero.

• user_id value must be an integer greater than zero.

Do a batch update of Permissions by passing in a modified graph. This should return the same graph, in the same format, that you got from GET /api/permissions/graph, with any changes made in the wherever necessary. This modified graph must correspond to the PermissionsGraph schema. If successful, this endpoint returns the updated permissions graph; use this as a base for any further modifications.

Revisions to the permissions graph are tracked. If you fetch the permissions graph and some other third-party modifies it before you can submit you revisions, the endpoint will instead make no changes and return a 409 (Conflict) response. In this case, you should fetch the updated graph and make desired changes to that.

You must be a superuser to do this.

• body value must be a map.

Update the name of a PermissionsGroup.

You must be a superuser to do this.

• group-id

• name value must be a non-blank string.

Fetch a Card you're considering embedding by passing a JWT TOKEN.

• token

Fetch the query results for a Card you're considering embedding by passing a JWT TOKEN.

• token

• &

• query-params

Fetch a Dashboard you're considering embedding by passing a JWT TOKEN.

• token

Fetch the results of running a Card belonging to a Dashboard you're considering embedding with JWT TOKEN.

• token

• dashcard-id

• card-id

• &

• query-params

Fetch a publicly-accessible Card an return query results as well as :card information. Does not require auth credentials. Public sharing must be enabled.

• uuid

Fetch remapped Field values. This is the same as GET /api/field/:id/remapping/:remapped-id, but for use with public Cards.

• uuid

• field-id

• remapped-id

• value value must be a non-blank string.

Search for values of a Field that is referenced by a public Card.

• uuid

• field-id

• search-field-id

• value value must be a non-blank string.

• limit value may be nil, or if non-nil, value must be a valid integer greater than zero.

Fetch FieldValues for a Field that is referenced by a public Card.

• uuid

• field-id

Fetch a publicly-accessible Card an return query results as well as :card information. Does not require auth credentials. Public sharing must be enabled.

• uuid

• parameters value may be nil, or if non-nil, value must be a valid JSON string.

Fetch a publicly-accessible Card and return query results in the specified format. Does not require auth credentials. Public sharing must be enabled.

• uuid

• export-format value must be one of: csv, json, xlsx.

• parameters value may be nil, or if non-nil, value must be a valid JSON string.

• respond

• raise

Fetch a publicly-accessible Dashboard. Does not require auth credentials. Public sharing must be enabled.

• uuid

Fetch the results for a Card in a publicly-accessible Dashboard. Does not require auth credentials. Public sharing must be enabled.

• uuid

• card-id

• parameters value may be nil, or if non-nil, value must be a valid JSON string.

Fetch remapped Field values. This is the same as GET /api/field/:id/remapping/:remapped-id, but for use with public Dashboards.

• uuid

• field-id

• remapped-id

• value value must be a non-blank string.

Search for values of a Field that is referenced by a Card in a public Dashboard.

• uuid

• field-id

• search-field-id

• value value must be a non-blank string.

• limit value may be nil, or if non-nil, value must be a valid integer greater than zero.

Fetch FieldValues for a Field that is referenced by a Card in a public Dashboard.

• uuid

• field-id

oEmbed endpoint used to retreive embed code and metadata for a (public) Metabase URL.

• url value must be a non-blank string.

• format value may be nil, or if non-nil, value must be one of: json.

• maxheight value may be nil, or if non-nil, value must be a valid integer.

• maxwidth value may be nil, or if non-nil, value must be a valid integer.

Delete a Pulse. (DEPRECATED -- don't delete a Pulse anymore -- archive it instead.)

• id

Fetch all Pulses

• archived value may be nil, or if non-nil, value must be a valid boolean string ('true' or 'false').

Fetch Pulse with ID.

• id

Provides relevant configuration information and user choices for creating/updating Pulses.

Get HTML rendering of a Card with id.

• id

Get JSON object containing HTML rendering of a Card with id and other information.

• id

Get PNG rendering of a Card with id.

• id

Create a new Pulse.

• name value must be a non-blank string.

• cards value must be an array. Each value must satisfy one of the following requirements: 1) value must be a map with the following keys (collection_id, description, display, id, include_csv, include_xls, name) 2) value must be a map with the keys id, include_csv, and include_xls. The array cannot be empty.

• channels value must be an array. Each value must be a map. The array cannot be empty.

• skip_if_empty value may be nil, or if non-nil, value must be a boolean.

• collection_id value may be nil, or if non-nil, value must be an integer greater than zero.

• collection_position value may be nil, or if non-nil, value must be an integer greater than zero.

Test send an unsaved pulse.

• name value must be a non-blank string.

• cards value must be an array. Each value must satisfy one of the following requirements: 1) value must be a map with the following keys (collection_id, description, display, id, include_csv, include_xls, name) 2) value must be a map with the keys id, include_csv, and include_xls. The array cannot be empty.

• channels value must be an array. Each value must be a map. The array cannot be empty.

• skip_if_empty value may be nil, or if non-nil, value must be a boolean.

• collection_id value may be nil, or if non-nil, value must be an integer greater than zero.

• collection_position value may be nil, or if non-nil, value must be an integer greater than zero.

Update a Pulse with id.

• id

• name value may be nil, or if non-nil, value must be a non-blank string.

• cards value may be nil, or if non-nil, value must be an array. Each value must satisfy one of the following requirements: 1) value must be a map with the following keys (collection_id, description, display, id, include_csv, include_xls, name) 2) value must be a map with the keys id, include_csv, and include_xls. The array cannot be empty.

• channels value may be nil, or if non-nil, value must be an array. Each value must be a map. The array cannot be empty.

• skip_if_empty value may be nil, or if non-nil, value must be a boolean.

• collection_id value may be nil, or if non-nil, value must be an integer greater than zero.

• archived value may be nil, or if non-nil, value must be a boolean.

• pulse-updates

Get revisions of an object.

• entity value must be one of: card, dashboard.

• id value must be an integer.

Revert an object to a prior revision.

• entity value must be one of: card, dashboard.

• id value must be an integer.

• revision_id value must be an integer.

Search Cards, Dashboards, Collections and Pulses for the substring q.

• q value may be nil, or if non-nil, value must be a non-blank string.

• archived value may be nil, or if non-nil, value must be a valid boolean string ('true' or 'false').

Archive a Segment. (DEPRECATED -- Just pass updated value of :archived to the PUT endpoint instead.)

• id

• revision_message value must be a non-blank string.

Fetch all Segments.

Fetch Segment with ID.

• id

Return related entities.

• id

Fetch Revisions for Segment with ID.

• id

Create a new Segment.

• name value must be a non-blank string.

• description value may be nil, or if non-nil, value must be a string.

• table_id value must be an integer greater than zero.

• definition value must be a map.

Revert a Segement to a prior Revision.

• id

• revision_id value must be an integer greater than zero.

Update a Segment with ID.

• points_of_interest value may be nil, or if non-nil, value must be a string.

• description value may be nil, or if non-nil, value must be a string.

• archived value may be nil, or if non-nil, value must be a boolean.

• definition value may be nil, or if non-nil, value must be a map.

• revision_message value must be a non-blank string.

• show_in_getting_started value may be nil, or if non-nil, value must be a boolean.

• name value may be nil, or if non-nil, value must be a non-blank string.

• caveats value may be nil, or if non-nil, value must be a string.

• id

Logout.

• metabase-session-id

Check is a password reset token is valid and isn't expired.

• token value must be a string.

Get all global properties and their values. These are the specific Settings which are meant to be public.

Login.

• username value must be a non-blank string.

• password value must be a non-blank string.

• remote-address

• request

Send a reset email when user has forgotten their password.

• server-name

• email value must be a valid email address.

• remote-address

Login with Google Auth.

• token value must be a non-blank string.

• remote-address

• request

Reset password with a reset token.

• token value must be a non-blank string.

• password Insufficient password strength

• request

Get all Settings and their values. You must be a superuser to do this.

You must be a superuser to do this.

Fetch a single Setting. You must be a superuser to do this.

You must be a superuser to do this.

• key value must be a non-blank string.

Update multiple Settings values. You must be a superuser to do this.

You must be a superuser to do this.

• settings

Create/update a Setting. You must be a superuser to do this. This endpoint can also be used to delete Settings by passing nil for :value.

You must be a superuser to do this.

• key value must be a non-blank string.

• value

Return various "admin checklist" steps and whether they've been completed. You must be a superuser to see this!

You must be a superuser to do this.

Special endpoint for creating the first user during setup. This endpoint both creates the user AND logs them in and returns a session ID.

• engine

• schedules value may be nil, or if non-nil, value must be a valid map of schedule maps for a DB.

• allow_tracking value may be nil, or if non-nil, value must satisfy one of the following requirements: 1) value must be a boolean. 2) value must be a valid boolean string ('true' or 'false').

• email value must be a valid email address.

• first_name value must be a non-blank string.

• request

• password Insufficient password strength

• name

• is_full_sync

• site_name value must be a non-blank string.

• token Token does not match the setup token.

• details

• is_on_demand

• last_name value must be a non-blank string.

Validate that we can connect to a database given a set of details.

• engine value must be a valid database engine.

• details

• token Token does not match the setup token.

Update Slack related settings. You must be a superuser to do this.

You must be a superuser to do this.

• slack-token value may be nil, or if non-nil, value must be a non-blank string.

• metabot-enabled value must be a boolean.

• slack-settings

Get all Tables.

Get Table with ID.

• id

Get all foreign keys whose destination is a Field that belongs to this Table.

• id

Get metadata about a Table useful for running queries. Returns DB, fields, field FKs, and field values.

By passing include_sensitive_fields=true, information about sensitive Fields will be returned; in no case will any of its corresponding values be returned. (This option is provided for use in the Admin Edit Metadata page).

• id

• include_sensitive_fields value may be nil, or if non-nil, value must be a valid boolean string ('true' or 'false').

Return related entities.

• id

Return FK info for the 'virtual' table for a Card. This is always empty, so this endpoint serves mainly as a placeholder to avoid having to change anything on the frontend.

Return metadata for the 'virtual' table for a Card.

• id

Discard the FieldValues belonging to the Fields in this Table. Only applies to fields that have FieldValues. If this Table's Database is set up to automatically sync FieldValues, they will be recreated during the next cycle.

You must be a superuser to do this.

• id

Manually trigger an update for the FieldValues for the Fields belonging to this Table. Only applies to Fields that are eligible for FieldValues.

You must be a superuser to do this.

• id

Update Table with ID.

• id

• display_name value may be nil, or if non-nil, value must be a non-blank string.

• entity_type value may be nil, or if non-nil, value must be a valid entity type (keyword or string).

• visibility_type value may be nil, or if non-nil, value must be one of: cruft, hidden, technical.

• description value may be nil, or if non-nil, value must be a non-blank string.

• caveats value may be nil, or if non-nil, value must be a non-blank string.

• points_of_interest value may be nil, or if non-nil, value must be a non-blank string.

• show_in_getting_started value may be nil, or if non-nil, value must be a boolean.

Fetch a list of recent tasks stored as Task History

You must be a superuser to do this.

• limit value may be nil, or if non-nil, value must be a valid integer greater than zero.

• offset value may be nil, or if non-nil, value must be a valid integer greater than or equal to zero.

Get TaskHistory entry with ID.

• id

Return raw data about all scheduled tasks (i.e., Quartz Jobs and Triggers).

You must be a superuser to do this.

This endpoints provides an image with the appropriate pins rendered given a MBQL QUERY (passed as a GET query string param). We evaluate the query and find the set of lat/lon pairs which are relevant and then render the appropriate ones. It's expected that to render a full map view several calls will be made to this endpoint in parallel.

• zoom value must be a valid integer.

• x value must be a valid integer.

• y value must be a valid integer.

• lat-field-id value must be an integer greater than zero.

• lon-field-id value must be an integer greater than zero.

• lat-col-idx value must be a valid integer.

• lon-col-idx value must be a valid integer.

• query value must be a valid JSON string.

Disable a User. This does not remove the User from the DB, but instead disables their account.

You must be a superuser to do this.

• id

Fetch a list of Users for the admin People page or for Pulses. By default returns only active users. If include_deactivated is true, return all Users (active and inactive). (Using include_deactivated requires superuser permissions.)

• include_deactivated value may be nil, or if non-nil, value must be a valid boolean string ('true' or 'false').

Fetch a User. You must be fetching yourself or be a superuser.

• id

Fetch the current User.

Create a new User, return a 400 if the email address is already taken

You must be a superuser to do this.

• first_name value must be a non-blank string.

• last_name value must be a non-blank string.

• email value must be a valid email address.

• password

• group_ids value may be nil, or if non-nil, value must be an array. Each value must be an integer greater than zero.

• login_attributes value may be nil, or if non-nil, value must be a map with each value either a string or number.

Resend the user invite email for a given user.

You must be a superuser to do this.

• id

Update an existing, active User.

• id

• email value may be nil, or if non-nil, value must be a valid email address.

• first_name value may be nil, or if non-nil, value must be a non-blank string.

• last_name value may be nil, or if non-nil, value must be a non-blank string.

• group_ids value may be nil, or if non-nil, value must be an array. Each value must be an integer greater than zero.

• is_superuser value may be nil, or if non-nil, value must be a boolean.

• login_attributes value may be nil, or if non-nil, value must be a map with each value either a string or number.

Update a user's password.

• id

• password Insufficient password strength

• old_password

Indicate that a user has been informed about the vast intricacies of 'the' Query Builder.

• id

Reactivate user at :id

You must be a superuser to do this.

• id

Logs.

You must be a superuser to do this.

Return a cryptographically secure random 32-byte token, encoded as a hexadecimal string. Intended for use when creating a value for embedding-secret-key.

Anonymous usage stats. Endpoint for testing, and eventually exposing this to instance admins to let them see what is being phoned home.

You must be a superuser to do this.

Endpoint that checks if the supplied password meets the currently configured password complexity rules.

• password Insufficient password strength