Sign in
/api/automagic-dashboards

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

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}

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.)

{"stackTrail":"paths:/api/automagic-dashboards/{entity}/{entity-id-or-query}/rule/{prefix}/{dashboard-template}:get:parameters:2:schema","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/api/automagic-dashboards/{entity}/{entity-id-or-query}/rule/{prefix}/{dashboard-template}:get:parameters:3:schema","oasType":"schema","type":"unknown"}

invalid value for dashboard template name

Query parameters

'all'
OR
integer

invalid show value

Response

Successful response

Changes

Changed in 1 of the 13 revisions of this API.1

  • 78297d193ca41See the full diff
    • ○

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

      api-operation-id-added

    This revision also has 47 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog