{ "opencollection": "1.0.0", "info": { "name": "CaptivateIQ Attribute Worksheets Dashboards API", "version": "v1" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Dashboards", "type": "folder" }, "items": [ { "info": { "name": "List Published Dashboards", "type": "http" }, "http": { "method": "GET", "url": "https://api.captivateiq.com/ciq/v1/dashboards/published-dashboards/", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "List Published Dashboards" }, { "info": { "name": "List Users With Access", "type": "http" }, "http": { "method": "GET", "url": "https://api.captivateiq.com/ciq/v1/dashboards/:dashboard_id/embedded_share", "params": [ { "name": "dashboard_id", "value": "", "type": "path", "description": "Dashboard ID" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "List Users With Access" }, { "info": { "name": "Share Dashboard", "type": "http" }, "http": { "method": "POST", "url": "https://api.captivateiq.com/ciq/v1/dashboards/:dashboard_id/embedded_share", "params": [ { "name": "dashboard_id", "value": "", "type": "path", "description": "ID of the dashboard to grant access to" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This dashboard will be shared with the selected individuals. Once granted access, these individuals will be able to see and download all data on this dashboard, including any data associated with peers.\nIt is not recommended to share sensitive data such as individual commission payouts on dashboards unless deemed necessary.\nBy using this API, you acknowledge the risks of sharing this dashboard, including any sensitive data it may contain." }, { "info": { "name": "Unshare Dashboard", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.captivateiq.com/ciq/v1/dashboards/:dashboard_id/embedded_share", "params": [ { "name": "dashboard_id", "value": "", "type": "path", "description": "ID of the dashboard to remove access from" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Unshare Dashboard" } ] } ], "bundled": true }