Sign in

v12

latestOpenAPI 3.1.0AGPL-3.0raw.githubusercontent.com2026-05-286377631.6 MB
/api/automagic-dashboards

GET /api/automagic-dashboards/{entity}/{entity-id-or-query}/compare/{comparison-entity}/{comparison-entity-id-or-query}

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

get/api/automagic-dashboards/{entity}/{entity-id-or-query}/compare/{comparison-entity}/{comparison-entity-id-or-query}

Path parameters

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

entity'adhoc' | 'field' | 'model' | 'question' | 'segment' | 'table' | 'transform' required
comparison-entity'adhoc' | 'segment' | 'table' required

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

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

Query parameters

'all'
OR
integer

invalid show value

Response

Successful response