{"swagger":"2.0","basePath":"/v1/dashboard","paths":{"/dashboards":{"post":{"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/wrapped_full_dashboard"}},"401":{"description":"Authentication failed"},"403":{"description":"Insufficient permissions"},"400":{"description":"Invalid parameters"},"404":{"description":"Unknown object"}},"summary":"Create a new dashboard","description":"The following permissions are required:\n - “Manage user's dashboards” (`9f03f5ee-95ec-4e8d-8924-9384b8e27007`)\n - “Manage dashboards” (`d836f7c3-20d4-4add-90a0-1b903a8e11c7`)","operationId":"post_dashboards_resource","parameters":[{"name":"data","in":"body","required":true,"type":"object"}],"tags":["dashboards"]},"get":{"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/list_of_dashboards"}},"401":{"description":"Authentication failed"},"403":{"description":"Insufficient permissions"}},"summary":"List dashboards","description":"The following permissions are required:\n - “View dashboards” (`e880a52e-fb5a-47ef-9071-57c4af03ed2f`)","operationId":"get_dashboards_resource","parameters":[{"name":"limit","in":"query","required":false,"type":"integer"},{"name":"offset","in":"query","required":false,"type":"integer"},{"name":"match[name]","in":"query","required":false,"type":"string"},{"name":"match[id]","in":"query","required":false,"type":"string"},{"name":"match[community_uuid]","in":"query","required":false,"type":"string"},{"name":"match[created_by]","in":"query","required":false,"type":"string"},{"name":"match[created_by_type]","in":"query","required":false,"type":"string"},{"name":"match[updated_by]","in":"query","required":false,"type":"string"},{"name":"match[updated_by_type]","in":"query","required":false,"type":"string"},{"name":"sort","in":"query","required":false,"type":"string","enum":["id","name","created_by","created","modified","updated_by"]},{"name":"direction","in":"query","required":false,"type":"string","enum":["desc","asc"]},{"name":"match[is_shared]","in":"query","required":false,"type":"boolean"}],"tags":["dashboards"]}},"/dashboards/dashboards_by_queries":{"get":{"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/dashboards_by_queries_response"}},"401":{"description":"Authentication failed"},"403":{"description":"Insufficient permissions"}},"summary":"Get usage of queries by dashboards","description":"The following permissions are required:\n - “View dashboards” (`e880a52e-fb5a-47ef-9071-57c4af03ed2f`)\n - “View notebook queries” (`50aa37c2-b108-458d-a52c-fb3204c9a592`)","operationId":"get_dashboards_by_queries_resource","parameters":[{"name":"uuids","in":"query","required":true,"type":"string"}],"tags":["dashboards"]}},"/dashboards/{uuid}":{"parameters":[{"name":"uuid","in":"path","required":true,"type":"string"}],"put":{"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/wrapped_full_dashboard"}},"401":{"description":"Authentication failed"},"403":{"description":"Insufficient permissions"},"400":{"description":"Invalid parameters"},"404":{"description":"Unknown object"}},"summary":"Update a dashboard","description":"The following permissions are required:\n - “Manage user's dashboards” (`9f03f5ee-95ec-4e8d-8924-9384b8e27007`)\n - “Manage dashboards” (`d836f7c3-20d4-4add-90a0-1b903a8e11c7`)","operationId":"put_dashboard_resource","parameters":[{"name":"data","in":"body","required":true,"type":"object"}],"tags":["dashboards"]},"delete":{"responses":{"204":{"description":"No content"},"401":{"description":"Authentication failed"},"403":{"description":"Insufficient permissions"},"404":{"description":"Unknown object"}},"summary":"Remove a dashboard","description":"The following permissions are required:\n - “Manage user's dashboards” (`9f03f5ee-95ec-4e8d-8924-9384b8e27007`)\n - “Manage dashboards” (`d836f7c3-20d4-4add-90a0-1b903a8e11c7`)","operationId":"delete_dashboard_resource","tags":["dashboards"]},"get":{"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/wrapped_full_dashboard"}},"401":{"description":"Authentication failed"},"403":{"description":"Insufficient permissions"},"404":{"description":"Unknown object"}},"summary":"Get a dashboard by  its UUID","description":"The following permissions are required:\n - “View dashboards” (`e880a52e-fb5a-47ef-9071-57c4af03ed2f`)","operationId":"get_dashboard_resource","tags":["dashboards"]}}},"info":{"title":"Dashboard API","version":"2.20261015-38663205067-685418d84fc4e08219d1929f6732318dfa1358e9","description":"Dashboard application"},"produces":["application/json"],"consumes":["application/json"],"securityDefinitions":{"accessToken":{"type":"apiKey","in":"header","name":"Authorization"}},"security":[{"accessToken":[]}],"tags":[{"name":"dashboards","description":"Dashboards endpoint"}],"definitions":{"wrapped_full_dashboard":{"required":["data"],"properties":{"data":{"description":"The full dashboard","allOf":[{"$ref":"#/definitions/full_dashboard"}]}},"type":"object"},"full_dashboard":{"required":["name"],"properties":{"id":{"type":"string","description":"The ID of the dashboard. Should be a valid UUID"},"name":{"type":"string","description":"The name of the dashboard"},"description":{"type":"string","description":"The description of the dashboard","default":""},"default_refresh_interval":{"type":"integer","description":"The interval the dashboard is refreshed","default":0},"default_range":{"type":"string","description":"The default time range of the dashboard","default":""},"autorefreshed":{"type":"boolean","description":"The dashboard is auto refreshed","default":false},"widgets":{"type":"array","description":"The widgets composing the dashboard","items":{"$ref":"#/definitions/widget"}},"version":{"type":"string","description":"The version of the dashboard","default":1},"pinned_parameters":{"type":"array","description":"The name of query parameters pinned to the dashboard","items":{"type":"string"}},"shared_with":{"type":"array","description":"UUIDs of communities the dashboard is shared with","items":{}},"community_uuid":{"type":"string","description":"The UUID of the community"},"created":{"type":"string","description":"The creation date of the dashboard"},"created_by":{"type":"string","description":"The dashboard creator UUID"},"created_by_type":{"type":"string","description":"The dashboard creator type"},"modified":{"type":"string","description":"The last modification date of the dashboard"},"updated_by":{"type":"string","description":"The dashboard updator UUID"},"updated_by_type":{"type":"string","description":"The dashboard updator type"}},"type":"object"},"widget":{"required":["cols","rows","type","x","y"],"properties":{"type":{"type":"string","description":"The type of the widget"},"x":{"type":"integer","description":"The X position of the widget in the dashboard"},"y":{"type":"integer","description":"The Y position of the widget in the dashboard"},"rows":{"type":"integer","description":"The number of rows of the widget"},"cols":{"type":"integer","description":"The number of columns of the widget"},"configuration":{"type":"object","description":"The configuration of the widget","additionalProperties":{}}},"type":"object"},"list_of_dashboards":{"required":["items","total"],"properties":{"items":{"type":"array","description":"A list of dashboards","items":{"$ref":"#/definitions/full_dashboard"}},"total":{"type":"integer","description":"The total number of dashboards"}},"type":"object"},"dashboards_by_queries_response":{}},"responses":{"ParseError":{"description":"When a mask can't be parsed"},"MaskError":{"description":"When any error occurs on mask"},"PlatformError":{"description":"When a generic error is raised"}}}