MEmetabase
/api/agent

POST /api/agent/v1/dashboard

Changed on

Create a new dashboard, optionally populated with saved questions.

Pass question_ids to add existing saved questions as cards on the dashboard. Cards are automatically positioned on the grid based on their display type. If collection_id is omitted the dashboard is saved to the caller's personal collection. Pass an explicit null to save it to the root collection. The response collection_path is the saved location.

post/api/agent/v1/dashboard

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

Request body

collection_idinteger nullable

value must be an integer greater than zero.

descriptionstring nullable
namestring required

value must be a non-blank string.

question_idsinteger[] nullable

Response

Successful response

collection_idinteger nullable required

value must be an integer greater than zero.

collection_pathstring required
dashcard_idsinteger[] required
descriptionstring nullable required
idinteger required

value must be an integer greater than zero.

namestring required

value must be a non-blank string.

urlstring required

Changes

  • 2e178f5a7934Revision changes
    • breaking

      removed subschema #1 subschema #2 from the request property oneOf list

    • breaking

      removed subschema #1 subschema #2 from the request property oneOf list

    • breaking

      removed subschema #1 subschema #2 from the request property oneOf list

    • info

      added subschema #1 subschema #2 to the request property anyOf list

    • info

      added subschema #1 subschema #2 to the request property anyOf list

    • info

      added subschema #1 subschema #2 to the request property anyOf list

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response property oneOf list for the response status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • b1dc4ea67567Revision changes
    • info

      endpoint added