MEmetabase
/api/automagic-dashboards

GET /api/automagic-dashboards/{entity}/{entity-id-or-query}/rule/{prefix}/{dashboard-template}

Changed on

Return an automagic dashboard for entity entity with id id using dashboard-template dashboard-template.

get/api/automagic-dashboards/{entity}/{entity-id-or-query}/rule/{prefix}/{dashboard-template}

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Path parameters

entity'adhoc' | 'field' | 'model' | 'question' | 'segment' | 'table' | 'transform' required
entity-id-or-querystring required

One of these:

  • A non-empty string with an Entity ID (including card__<id>-encoded Card IDs)

  • a form-encoded base-64-encoded JSON-encoded MBQL query

  • The name of a transform

(Effectively since the names of transforms are unconstrained this parameter is allowed to be any form-encoded string.)

prefixstring required
dashboard-templatestring required

invalid value for dashboard template name

Query parameters

'all'
OR
integer

invalid show value

Response

Successful response

Changes

  • 2e178f5a7934Revision changes
    • info

      for the path request parameter dashboard-template, the type was generalized from no type to string

    • info

      for the path request parameter prefix, the type was generalized from no type to string

  • 78297d193ca4Revision changes
    • info

      api operation id get-api-automagic-dashboards-entity-entity-id-or-query-rule-prefix-dashboard-template was added