The Databrain API provides endpoints for retrieving dashboards and metrics from data apps in both cloud Databrain and self-hosted Databrain environments.
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Databrain","colors":{"primary":"#111111","light":"#7f7f7f","dark":"#ffffff"},"logo":{"light":"https://mintcdn.com/databrainlabs-bef6850a/oDO13AKpVJ1B8Og7/logo/light.png?fit=max\u0026auto=format\u0026n=oDO13AKpVJ1B8Og7\u0026q=85\u0026s=0c708a71f56a15124f892fa695426863","dark":"https://mintcdn.com/databrainlabs-bef6850a/oDO13AKpVJ1B8Og7/logo/dark.png?fit=max\u0026auto=format\u0026n=oDO13AKpVJ1B8Og7\u0026q=85\u0026s=6fb12763fdc54348f76186c9efbd9f5b","href":"https://www.usedatabrain.com/"},"favicon":"https://mintcdn.com/databrainlabs-bef6850a/Bksca58pXCRbdPly/images/icons/favicon-192x192.png?fit=max\u0026auto=format\u0026n=Bksca58pXCRbdPly\u0026q=85\u0026s=2dec67559aa77ee9b73dee6e5a9eedcc","appearance":{"default":"light"},"background":{"color":{"light":"#ffffff"}},"navbar":{"links":[{"href":"https://playground.usedatabrain.com/","label":"Embed Playground"}],"primary":{"type":"button","label":"Start Building","href":"https://app.usedatabrain.com/users/sign-up?_gl=1*er2uvq*_gcl_au*MjA0NTIyMzg1Ni4xNzQ5MDIwOTkw"}},"footer":{"socials":{"x":"https://x.com/databrainhq","linkedin":"https://linkedin.com/company/databrainhq","youtube":"https://youtube.com/@usedatabrain?feature=shared"}},"seo":{"metatags":{"canonical":"https://docs.usedatabrain.com"}},"fonts":{"heading":{"family":"Inter"},"body":{"family":"Inter"}},"styling":{"codeblocks":"dark","latex":false},"integrations":{"gtm":{"tagId":"GTM-TFBLH49"},"intercom":{"appId":"bk07fem4"},"posthog":{"apiKey":"phc_YgR4BO3sbtQAUvTfRUEN5xBzzPrJfrEG9STJEy3mNO2"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"databrainlabs-bef6850a","hasAudioNarration":false,"actualSubdomain":"databrainlabs-bef6850a","customDomains":["docs.usedatabrain.com"],"gitSource":{"type":"github","owner":"databrainhq","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae4b9d6ab76b29675b26c4f","collectionId":"20b0ae05-0a09-42bb-a1b3-76acb91a2180","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae4b9d6ab76b29675b26c4f"},"entitlements":{},"buildId":"6ae8579a4729f9837cf126b4","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Platform Guides","count":125},{"language":"default","tag":"Developer Docs","count":78},{"language":"default","tag":"API Reference","count":56},{"language":"default","tag":"Visualizations","count":30},{"language":"default","tag":"Data Sources","count":26},{"language":"default","tag":"Metrics","count":24},{"language":"default","tag":"Chart Setup","count":21},{"language":"default","tag":"Supported Connectors","count":19},{"language":"default","tag":"Self-Hosted Deployment","count":13},{"language":"default","tag":"Data App APIs","count":13}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":"body{font-family:'Inter',-apple-system,BlinkMacSystemFont,'Segoe UI',sans-serif;line-height:1.6;color:#374151}[data-mode=wide] h1{font-size:2.5rem;font-weight:700;margin-bottom:1.5rem;color:#111827;line-height:1.2}[data-mode=wide] h2,[data-mode=wide] h3{font-size:1.875rem;font-weight:600;margin-top:2.5rem;margin-bottom:1rem;color:#111827;line-height:1.3}[data-mode=wide] h3{font-size:1.5rem;margin-top:2rem;margin-bottom:.75rem;line-height:1.4}[data-mode=wide] p{margin-bottom:1.25rem;word-wrap:break-word;overflow-wrap:break-word;color:#374151;line-height:1.7}[data-mode=wide] code{font-family:'JetBrains Mono','Fira Code',Consolas,monospace;font-size:.875rem}[data-mode=wide] li code,[data-mode=wide] p code,[data-mode=wide] td code{background-color:#f3f4f6;color:#1f2937;padding:.125rem .375rem;border-radius:4px;font-size:.8125rem;font-weight:500;word-break:break-word}[data-mode=wide] pre{background-color:#1f2937;border-radius:8px;padding:1.5rem;margin:1.5rem 0;overflow-x:auto;border:1px solid #374151}[data-mode=wide] pre code{color:#e5e7eb;font-size:.875rem;line-height:1.6}[data-mode=wide] a{color:#111;text-decoration:underline;text-underline-offset:2px;transition:color .2s ease}[data-mode=wide] a:hover{color:#7f7f7f}[data-mode=wide] table{width:100%;border-collapse:collapse;margin:1.5rem 0;font-size:.875rem;border-radius:8px;overflow:hidden;box-shadow:0 1px 3px 0 rgba(0,0,0,.1);border:1px solid #e5e7eb}[data-mode=wide] table td,[data-mode=wide] table th{padding:1rem;text-align:left;border-bottom:1px solid #e5e7eb;word-wrap:break-word;vertical-align:top}[data-mode=wide] table th{background-color:#f9fafb;font-weight:600;color:#111827;font-size:.875rem}[data-mode=wide] table tbody tr:hover{background-color:#f9fafb}[data-mode=wide] table tbody tr:last-child td{border-bottom:none}[data-mode=wide] ol,[data-mode=wide] ul{margin-bottom:1.25rem;padding-left:1.5rem}[data-mode=wide] li{margin-bottom:.5rem;line-height:1.6}[data-mode=wide] li p{margin-bottom:.5rem}[data-mode=wide] .frame,[data-mode=wide] [class*=frame]{margin:1.5rem 0;border-radius:8px;overflow:hidden;box-shadow:0 1px 3px 0 rgba(0,0,0,.1)}[data-mode=wide] .card,[data-mode=wide] [class*=card]{margin:1rem 0;border-radius:8px;border:1px solid #e5e7eb;transition:all .2s ease}[data-mode=wide] .card:hover,[data-mode=wide] [class*=card]:hover{box-shadow:0 4px 12px 0 rgba(0,0,0,.1);transform:translateY(-1px)}[data-mode=wide] blockquote{border-left:4px solid #111;padding:1rem 1rem 1rem 1.5rem;margin:1.5rem 0;background-color:#f9fafb;border-radius:0 8px 8px 0;font-style:italic;color:#6b7280}[data-mode=wide] h2+pre,[data-mode=wide] h2+table,[data-mode=wide] h3+pre,[data-mode=wide] h3+table,[data-mode=wide] ol+pre,[data-mode=wide] p+pre,[data-mode=wide] ul+pre{margin-top:1rem}[data-mode=wide] ::selection{background-color:#ddd6fe;color:#1f2937}.right-panel,div[data-orientation=right]{width:400px!important}[data-mode=wide] .panel,[data-mode=wide] [class*=panel],aside[class*=right],nav[class*=right]{width:400px!important;min-width:400px!important;max-width:400px!important}#navbar #topbar-cta-button,#navbar nav a[href*=\"playground.usedatabrain.com\"]{box-sizing:border-box!important;display:inline-flex!important;flex-direction:row!important;align-items:center!important;justify-content:center!important;gap:8px!important;width:168px!important;min-width:168px!important;max-width:168px!important;height:36px!important;min-height:36px!important;max-height:36px!important;padding:0 12px!important;border-radius:4px!important;border-width:1px!important;border-style:solid!important;font-family:'SF Mono','SFMono-Regular',ui-monospace,'Cascadia Mono','Segoe UI Mono',Menlo,Monaco,Consolas,monospace!important;font-size:.875rem!important;font-weight:500!important;line-height:1!important;text-decoration:none!important;white-space:nowrap!important;transition:all .2s ease!important}@media (max-width:1023px){#navbar #topbar-cta-button{display:none!important}}#navbar nav a[href*=\"playground.usedatabrain.com\"]{background-color:#fff!important;border-color:#d1d5db!important;color:#1f2937!important}#navbar nav a[href*=\"playground.usedatabrain.com\"] *{color:#1f2937!important}#navbar nav a[href*=\"playground.usedatabrain.com\"]:hover{background-color:#f3f4f6!important;border-color:#9ca3af!important;color:#111827!important}#navbar #topbar-cta-button{background-color:#0d0d0d!important;border-color:#404040!important;cursor:pointer!important;color:#fff!important;visibility:visible!important;opacity:1!important}#navbar #topbar-cta-button:hover{background-color:#1a1a1a!important;border-color:#525252!important}#navbar #topbar-cta-button>a{justify-content:center!important;width:100%!important;height:100%!important;text-decoration:none!important}#navbar #topbar-cta-button>a,#navbar #topbar-cta-button>a>div{display:inline-flex!important;align-items:center!important;margin:0!important;padding:0!important;line-height:1!important}#navbar #topbar-cta-button *{color:#fff!important}#navbar #topbar-cta-button svg{display:none!important}#navbar #topbar-cta-button *,#navbar a,#navbar button,#navbar span{visibility:visible!important;opacity:1!important}#sidebar-content .method-nav-pill>span[class*=\"bg-[#2AB673]\"]{background-color:rgba(74,222,128,.2)!important;color:#15803d!important}#sidebar-content .method-nav-pill>span[class*=\"bg-[#3064E3]\"]{background-color:rgba(96,165,250,.2)!important;color:#1d4ed8!important}#sidebar-content .method-nav-pill>span[class*=\"bg-[#C28C30]\"]{background-color:rgba(250,204,21,.2)!important;color:#a16207!important}#sidebar-content .method-nav-pill>span[class*=\"bg-[#CB3A32]\"]{background-color:rgba(248,113,113,.2)!important;color:#b91c1c!important}html.dark #sidebar-content .method-nav-pill>span[class*=\"bg-[#2AB673]\"]{color:#4ade80!important}html.dark #sidebar-content .method-nav-pill>span[class*=\"bg-[#3064E3]\"]{color:#60a5fa!important}html.dark #sidebar-content .method-nav-pill>span[class*=\"bg-[#C28C30]\"]{color:#facc15!important}html.dark #sidebar-content .method-nav-pill>span[class*=\"bg-[#CB3A32]\"]{color:#f87171!important}"}],"page":{"pagePath":"developer-docs/helpers/api-reference/data-app-embedding-api","slug":"/developer-docs/helpers/api-reference/data-app-embedding-api","pageMetadata":{"title":"Data App Embedding APIs","description":"Retrieve dashboards and metrics from datapps","sidebarTitle":"Data App Embedding APIs","href":"/developer-docs/helpers/api-reference/data-app-embedding-api"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieve dashboards and metrics from datapps\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`3`,id:`overview`,children:`Overview`}),`\n`,_jsx(_components.p,{children:`The Databrain API provides endpoints for retrieving dashboards and metrics from data apps in both cloud Databrain and self-hosted Databrain environments.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Data App Embedding APIs","description":"Retrieve dashboards and metrics from datapps","sidebarTitle":"Data App Embedding APIs","href":"/developer-docs/helpers/api-reference/data-app-embedding-api"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Overview","slug":"overview","depth":3,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"databrainlabs-bef6850a","siteName":"Databrain","title":"Data App Embedding APIs - Databrain","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-22T09:07:00.138Z","originalFileLocation":"developer-docs/helpers/api-reference/data-app-embedding-api.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieve dashboards and metrics from datapps\">\u003cmeta data-mint-head name=\"application-name\" content=\"Databrain\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/databrainlabs-bef6850a/QUX3KO15cdFhUybZ/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/databrainlabs-bef6850a/QUX3KO15cdFhUybZ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/databrainlabs-bef6850a/QUX3KO15cdFhUybZ/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/databrainlabs-bef6850a/QUX3KO15cdFhUybZ/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/databrainlabs-bef6850a/QUX3KO15cdFhUybZ/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/databrainlabs-bef6850a/QUX3KO15cdFhUybZ/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/databrainlabs-bef6850a/QUX3KO15cdFhUybZ/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/databrainlabs-bef6850a/QUX3KO15cdFhUybZ/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/databrainlabs-bef6850a/QUX3KO15cdFhUybZ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Data App Embedding APIs - Databrain\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve dashboards and metrics from datapps\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Databrain\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.usedatabrain.com/developer-docs/helpers/api-reference/data-app-embedding-api\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://databrainlabs-bef6850a.mintlify.app/_mintlify/api/og/v2?division=Data+App+APIs\u0026amp;title=Data+App+Embedding+APIs\u0026amp;description=Retrieve+dashboards+and+metrics+from+datapps\u0026amp;theme=3b64d65987e1a62f702b458e\u0026amp;signature=0f02cbf5d48cd4550b49595a026a3507c8a02621aa4c99e443d6cbbe3ee9ad43\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Data App Embedding APIs - Databrain\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve dashboards and metrics from datapps\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://databrainlabs-bef6850a.mintlify.app/_mintlify/api/og/v2?division=Data+App+APIs\u0026amp;title=Data+App+Embedding+APIs\u0026amp;description=Retrieve+dashboards+and+metrics+from+datapps\u0026amp;theme=3b64d65987e1a62f702b458e\u0026amp;signature=0f02cbf5d48cd4550b49595a026a3507c8a02621aa4c99e443d6cbbe3ee9ad43\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/databrainlabs-bef6850a/QUX3KO15cdFhUybZ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Databrain\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#111111\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.usedatabrain.com/developer-docs/helpers/api-reference/data-app-embedding-api\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/developer-docs/helpers/api-reference/data-app-embedding-api.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.usedatabrain.com/#organization\",\"name\":\"Databrain\",\"url\":\"https://docs.usedatabrain.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/databrainlabs-bef6850a/oDO13AKpVJ1B8Og7/logo/light.png?fit=max\u0026auto=format\u0026n=oDO13AKpVJ1B8Og7\u0026q=85\u0026s=0c708a71f56a15124f892fa695426863\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.usedatabrain.com#website\",\"name\":\"Databrain\",\"url\":\"https://docs.usedatabrain.com\",\"publisher\":{\"@id\":\"https://docs.usedatabrain.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.usedatabrain.com/developer-docs/helpers/api-reference/data-app-embedding-api#webpage\",\"url\":\"https://docs.usedatabrain.com/developer-docs/helpers/api-reference/data-app-embedding-api\",\"name\":\"Data App Embedding APIs\",\"description\":\"Retrieve dashboards and metrics from datapps\",\"dateModified\":\"2026-01-22T09:07:00.138Z\",\"isPartOf\":{\"@id\":\"https://docs.usedatabrain.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.usedatabrain.com/developer-docs/helpers/api-reference/data-app-embedding-api#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.usedatabrain.com/developer-docs/helpers/api-reference/data-app-embedding-api#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Databrain\",\"item\":\"https://docs.usedatabrain.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Data App Embedding APIs\",\"item\":\"https://docs.usedatabrain.com/developer-docs/helpers/api-reference/data-app-embedding-api\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.usedatabrain.com/developer-docs/helpers/api-reference/data-app-embedding-api#article\",\"headline\":\"Data App Embedding APIs\",\"name\":\"Data App Embedding APIs\",\"description\":\"Retrieve dashboards and metrics from datapps\",\"url\":\"https://docs.usedatabrain.com/developer-docs/helpers/api-reference/data-app-embedding-api\",\"mainEntityOfPage\":{\"@id\":\"https://docs.usedatabrain.com/developer-docs/helpers/api-reference/data-app-embedding-api#webpage\"},\"dateModified\":\"2026-01-22T09:07:00.138Z\",\"publisher\":{\"@id\":\"https://docs.usedatabrain.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.usedatabrain.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Databrain\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Databrain","nav":{"global":null,"tabs":[{"tab":"Getting Started","pages":[{"title":"Getting Started","href":"/getting-started/introduction"}]},{"tab":"Platform Guides","pages":[{"title":"Platform Guides","href":"/guides/onboarding-and-configuration/onboarding"}]},{"tab":"Developer Docs","pages":[{"title":"Developer Docs","href":"/developer-docs"}]},{"tab":"API Reference","groups":[{"group":"Authentication","icon":"key","pages":[{"title":"Guest Token","api":"POST https://api.usedatabrain.com/api/v2/guest-token/create","href":"/developer-docs/helpers/api-reference/token"}]},{"group":"Datasource APIs","icon":"plug","pages":[{"title":"Create Datasource","api":"POST https://api.usedatabrain.com/api/v2/datasource","href":"/developer-docs/helpers/api-reference/create-datasource"},{"title":"List Datasources","api":"GET https://api.usedatabrain.com/api/v2/datasource","href":"/developer-docs/helpers/api-reference/list-datasources"},{"title":"Update Datasource","api":"PUT https://api.usedatabrain.com/api/v2/datasource","href":"/developer-docs/helpers/api-reference/update-datasource"},{"title":"Delete Datasource","api":"DELETE https://api.usedatabrain.com/api/v2/datasource?datasourceName={name}","href":"/developer-docs/helpers/api-reference/delete-datasource"},{"title":"Sync Datasource","api":"POST https://api.usedatabrain.com/api/v2/datasource/sync","href":"/developer-docs/helpers/api-reference/sync-datasource"},{"title":"Get AWSS3 sync Progress status","api":"POST https://api.usedatabrain.com/api/v2/datasource/getDatasourceProgress","href":"/developer-docs/helpers/api-reference/get-awss3-sync-progress-status"}]},{"group":"Datamart APIs","icon":"database","pages":[{"title":"Datamart API","sidebarTitle":"Datamart API","href":"/developer-docs/helpers/api-reference/datamart-api"},{"title":"Create Datamart","api":"POST https://api.usedatabrain.com/api/v2/data-app/datamarts","href":"/developer-docs/helpers/api-reference/create-datamart"},{"title":"List Datamarts","api":"GET https://api.usedatabrain.com/api/v2/data-app/datamarts","href":"/developer-docs/helpers/api-reference/list-datamarts"},{"title":"Update Datamart","api":"PUT https://api.usedatabrain.com/api/v2/data-app/datamarts","href":"/developer-docs/helpers/api-reference/update-datamart"},{"title":"Delete Datamart","api":"DELETE https://api.usedatabrain.com/api/v2/data-app/datamart?datamartName={name}","href":"/developer-docs/helpers/api-reference/delete-datamart"}]},{"group":"Semantic Layer APIs","icon":"layer-group","pages":[{"title":"Semantic Layer API","sidebarTitle":"Semantic Layer API","href":"/developer-docs/helpers/api-reference/semantic-layer-api"},{"title":"Get Semantic Layer","api":"GET https://api.usedatabrain.com/api/v2/data-app/datamarts/semantic-layer","href":"/developer-docs/helpers/api-reference/get-semantic-layer"},{"title":"Create Semantic Layer","api":"POST https://api.usedatabrain.com/api/v2/data-app/datamarts/semantic-layer","href":"/developer-docs/helpers/api-reference/create-semantic-layer"},{"title":"Update Semantic Layer","api":"PUT https://api.usedatabrain.com/api/v2/data-app/datamarts/semantic-layer","href":"/developer-docs/helpers/api-reference/update-semantic-layer"},{"title":"Delete Semantic Layer","api":"DELETE https://api.usedatabrain.com/api/v2/data-app/datamarts/semantic-layer?datamartName={name}","href":"/developer-docs/helpers/api-reference/delete-semantic-layer"}]},{"group":"Workspace APIs","icon":"building","pages":[{"title":"Create Workspace","api":"POST https://api.usedatabrain.com/api/v2/workspace","href":"/developer-docs/helpers/api-reference/create-workspace"},{"title":"List Workspaces","api":"GET https://api.usedatabrain.com/api/v2/workspace","href":"/developer-docs/helpers/api-reference/list-workspaces"},{"title":"Update Workspace","api":"PUT https://api.usedatabrain.com/api/v2/workspace","href":"/developer-docs/helpers/api-reference/update-workspace"},{"title":"Update Workspace Dashboards","api":"PUT https://api.usedatabrain.com/api/v2/workspace/dashboards","href":"/developer-docs/helpers/api-reference/update-workspace-dashboards"},{"title":"Delete Workspace","api":"DELETE https://api.usedatabrain.com/api/v2/workspace?name={name}","href":"/developer-docs/helpers/api-reference/delete-workspace"},{"group":"Embedding API","pages":[{"title":"Embedding APIs","sidebarTitle":"Embedding APIs","href":"/developer-docs/helpers/api-reference/embedding-apis"},{"title":"Fetch Dashboards by Workspace","api":"POST https://api.usedatabrain.com/api/v2/workspace/dashboards","href":"/developer-docs/helpers/api-reference/cloud-databrain-endpoint"},{"title":"Fetch Metrics by Workspace","api":"POST https://api.usedatabrain.com/api/v2/workspace/metrics","href":"/developer-docs/helpers/api-reference/fetch-metrics-by-workspace"}]}]},{"group":"Embeds","icon":"gear","pages":[{"title":"Embed Data App API (CRUD)","sidebarTitle":"Embed Data App API (CRUD)","href":"/developer-docs/helpers/api-reference/embed-data-app-crud"},{"title":"Embed a Pre-built Dashboard/Metric","sidebarTitle":"Embed a Pre-built Dashboard/Metric","api":"POST https://api.usedatabrain.com/api/v2/data-app/embeds","href":"/developer-docs/helpers/api-reference/create-embed"},{"title":"Create an Empty Dashboard Embed","sidebarTitle":"Create an Empty Dashboard Embed","api":"POST https://api.usedatabrain.com/api/v2/data-app/dashboard-embeds","href":"/developer-docs/helpers/api-reference/create-dashboard-embed"},{"title":"List All Embeds","api":"GET https://api.usedatabrain.com/api/v2/data-app/embeds","href":"/developer-docs/helpers/api-reference/list-embed"},{"title":"List Schedule Reports by Embed","api":"GET https://api.usedatabrain.com/api/v2/data-app/embeds/reports?embedId={id}\u0026clientId={client_xyz789}\u0026isPagination=true\u0026pageNumber=1","href":"/developer-docs/helpers/api-reference/list-schedule-reports-by-embed"},{"title":"Update an Embed","sidebarTitle":"Update an Embed","api":"PUT https://api.usedatabrain.com/api/v2/data-app/embeds","href":"/developer-docs/helpers/api-reference/update-embed"},{"title":"Update Embedded Filter Alias","sidebarTitle":"Update Filter Alias","href":"/developer-docs/helpers/api-reference/update-filter-alias"},{"title":"Rename an Embed","sidebarTitle":"Rename an Embed","api":"PUT https://api.usedatabrain.com/api/v2/data-app/embeds/rename","href":"/developer-docs/helpers/api-reference/rename-embed"},{"title":"Delete an Embed","sidebarTitle":"Delete an Embed","api":"DELETE https://api.usedatabrain.com/api/v2/data-app/embeds?embedId={id}","href":"/developer-docs/helpers/api-reference/delete-embed"},{"title":"Export Embedded Dashboard","sidebarTitle":"Export Embedded Dashboard","api":"GET https://api.usedatabrain.com/api/v2/data-app/embeds/export?embedId={embed_abc123}","href":"/developer-docs/helpers/api-reference/export-embed"},{"title":"Whitelist Domains","sidebarTitle":"Whitelist Domains","api":"GET https://api.usedatabrain.com/api/v2/data-app/whitelist-domains","href":"/developer-docs/helpers/api-reference/whitelist-domains"},{"title":"SMTP Settings","sidebarTitle":"SMTP Settings","api":"PUT https://api.usedatabrain.com/api/v2/data-app/smtp-settings","description":"Configure SMTP settings for your data app so scheduled reports can be sent by email.","href":"/developer-docs/helpers/api-reference/smtp-settings"}]},{"group":"Data App APIs","icon":"layer-group","pages":[{"title":"Data App Embedding APIs","sidebarTitle":"Data App Embedding APIs","href":"/developer-docs/helpers/api-reference/data-app-embedding-api"},{"group":"Data App CRUD","pages":[{"title":"Create Data App","sidebarTitle":"Create Data App","api":"POST https://api.usedatabrain.com/api/v2/data-app","description":"Create a new Data App to organize and manage your embedded analytics.","href":"/developer-docs/helpers/api-reference/create-data-app"},{"title":"List Data Apps","sidebarTitle":"List Data Apps","api":"GET https://api.usedatabrain.com/api/v2/data-app","href":"/developer-docs/helpers/api-reference/list-data-apps"},{"title":"Update Data App","sidebarTitle":"Update Data App","api":"PUT https://api.usedatabrain.com/api/v2/data-app","href":"/developer-docs/helpers/api-reference/update-data-app"},{"title":"Delete Data App","sidebarTitle":"Delete Data App","api":"DELETE https://api.usedatabrain.com/api/v2/data-app?name={name}","href":"/developer-docs/helpers/api-reference/delete-data-app"}]},{"group":"API Tokens","pages":[{"title":"Create API Token for Data App","sidebarTitle":"Create API Token","api":"POST https://api.usedatabrain.com/api/v2/data-app/api-tokens","href":"/developer-docs/helpers/api-reference/create-api-token"},{"title":"List API Tokens for Data App","sidebarTitle":"List API Tokens","api":"GET https://api.usedatabrain.com/api/v2/data-app/api-tokens?dataAppName={name}","href":"/developer-docs/helpers/api-reference/list-api-tokens"},{"title":"Rotate API Key","api":"POST https://api.usedatabrain.com/api/v2/data-app/rotate-api","href":"/developer-docs/helpers/api-reference/rotate-api-key"}]},{"group":"Data Retrieval","pages":[{"title":"Fetch Dashboards by Data App","api":"GET https://api.usedatabrain.com/api/v2/data-app/dashboards","href":"/developer-docs/helpers/api-reference/fetch-dashboards-by-datapp"},{"title":"Fetch Metrics by Embed and Client","api":"GET https://api.usedatabrain.com/api/v2/data-app/metrics?embedId={id}\u0026clientId={client_xyz789}\u0026isPagination=true\u0026pageNumber=1","href":"/developer-docs/helpers/api-reference/fetch-metrics-by-embed-and-client"},{"title":"Fetch metric data by data app","api":"POST https://api.usedatabrain.com/api/v2/data-app/query","href":"/developer-docs/helpers/api-reference/fetch-metric-data-by-dataapp"},{"title":"Export Dashboard","sidebarTitle":"Export Dashboard","api":"POST https://api.usedatabrain.com/api/v2/data-app/export-dashboard","href":"/developer-docs/helpers/api-reference/export-dashboard"},{"title":"Import Dashboard","sidebarTitle":"Import Dashboard","api":"POST https://api.usedatabrain.com/api/v2/data-app/import-dashboard","href":"/developer-docs/helpers/api-reference/import-dashboard"}]}]},{"group":"Metric APIs","icon":"chart-line","pages":[{"title":"Publish/Unpublish Metric","api":"PUT https://api.usedatabrain.com/api/v2/data-app/metrics/publish","href":"/developer-docs/helpers/api-reference/publish-metric"}]},{"group":"Self-Hosted APIs","icon":"server","pages":[{"title":"Create Admin Account (Self-Hosted)","sidebarTitle":"Create Admin Account","api":"POST https://api.usedatabrain.com/api/v2/admin-account","href":"/developer-docs/helpers/api-reference/create-admin-account"},{"title":"Create Admin JWT (Self-Hosted)","sidebarTitle":"Create Admin JWT","api":"POST https://api.usedatabrain.com/api/v2/admin-account/jwt","href":"/developer-docs/helpers/api-reference/create-admin-jwt"},{"title":"Create Service Token (Self-Hosted)","sidebarTitle":"Create Service Token","api":"POST https://api.usedatabrain.com/api/v2/service-token","href":"/developer-docs/helpers/api-reference/create-service-token"},{"title":"Rotate Service Token","sidebarTitle":"Rotate Service Token","api":"POST https://api.usedatabrain.com/api/v2/service-token/rotate","href":"/developer-docs/helpers/api-reference/rotate-service-token"},{"title":"Reset Admin Password (Self-Hosted)","sidebarTitle":"Reset Admin Password","api":"POST https://api.usedatabrain.com/api/v2/service-token/reset-password","href":"/developer-docs/helpers/api-reference/reset-admin-password"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/product-changelog"}]}]},"basePath":"","title":"Data App Embedding APIs - Databrain","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":[],"chunks":[]}
