-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathindex.html
More file actions
28 lines (25 loc) · 21.2 KB
/
index.html
File metadata and controls
28 lines (25 loc) · 21.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
<!doctype html>
<html lang="en" dir="ltr" class="plugin-openapi plugin-id-default" data-has-hydrated="false">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.9.2">
<title data-rh="true">Performance Profile JSON | Feldera Documentation</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.feldera.com/api/performance-profile-json"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docusaurus_tag" content="default"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:docusaurus_tag" content="default"><meta data-rh="true" property="og:title" content="Performance Profile JSON | Feldera Documentation"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.feldera.com/api/performance-profile-json"><link data-rh="true" rel="alternate" href="https://docs.feldera.com/api/performance-profile-json" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.feldera.com/api/performance-profile-json" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://WX24466N8W-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Feldera Documentation" href="/opensearch.xml">
<link rel="preconnect" href="https://us.i.posthog.com">
<script>!function(t,e){var o,s,r,a;e.__SV||(window.posthog=e,e._i=[],e.init=function(i,n,p){function c(t,e){var o=e.split(".");2==o.length&&(t=t[o[0]],e=o[1]),t[e]=function(){t.push([e].concat(Array.prototype.slice.call(arguments,0)))}}(r=t.createElement("script")).type="text/javascript",r.async=!0,r.src=n.api_host.replace(".i.posthog.com","-assets.i.posthog.com")+"/static/array.js",(a=t.getElementsByTagName("script")[0]).parentNode.insertBefore(r,a);var g=e;for(void 0!==p?g=e[p]=[]:p="posthog",g.people=g.people||[],g.toString=function(t){var e="posthog";return"posthog"!==p&&(e+="."+p),t||(e+=" (stub)"),e},g.people.toString=function(){return g.toString(1)+".people (stub)"},o="capture identify alias people.set people.set_once set_config register register_once unregister opt_out_capturing has_opted_out_capturing opt_in_capturing reset isFeatureEnabled onFeatureFlags getFeatureFlag getFeatureFlagPayload reloadFeatureFlags group updateEarlyAccessFeatureEnrollment getEarlyAccessFeatures getActiveMatchingSurveys getSurveys onSessionId".split(" "),s=0;s<o.length;s++)c(g,o[s]);e._i.push([i,n,p])},e.__SV=1)}(document,window.posthog||[]),posthog.init("phc_GKR68l5zo531AD1R3cnE3MCPEBPXTqgYax4q053LVBD",{api_host:"https://us.i.posthog.com",id:"default"})</script>
<script async defer="defer" id="hs-script-loader" src="//js.hs-scripts.com/45801078.js"></script><link rel="stylesheet" href="/assets/css/styles.b3ba7e83.css">
<script src="/assets/js/runtime~main.02683f3e.js" defer="defer"></script>
<script src="/assets/js/main.310554a7.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<svg style="display: none;"><defs>
<symbol id="theme-svg-external-link" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
</defs></svg>
<script>document.documentElement.setAttribute("data-theme","light"),document.documentElement.setAttribute("data-theme-choice","light"),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a href="https://www.feldera.com" target="_blank" rel="noopener noreferrer" class="navbar__brand"><div class="navbar__logo"><img src="/img/logo-color-dark.svg" alt="Feldera Logo" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/logo-color-light.svg" alt="Feldera Logo" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div></a><a class="navbar__item navbar__link" href="/get-started">Get Started</a><a class="navbar__item navbar__link" href="/sql">SQL Reference</a><a class="navbar__item navbar__link" href="/connectors">Connectors</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Community</a><ul class="dropdown__menu"><li><a href="https://join.slack.com/t/felderacommunity/shared_invite/zt-222bq930h-dgsu5IEzAihHg8nQt~dHzA" target="_blank" rel="noopener noreferrer" class="dropdown__link">Slack<svg width="12" height="12" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li><a href="https://discord.com/invite/s6t5n9UzHE" target="_blank" rel="noopener noreferrer" class="dropdown__link">Discord<svg width="12" height="12" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li><a href="https://github.com/feldera/feldera" target="_blank" rel="noopener noreferrer" class="dropdown__link">GitHub<svg width="12" height="12" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div><div class="navbarSearchContainer_Bca1"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search (Meta+k)" aria-keyshortcuts="Meta+k"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 24 24" aria-hidden="true"><circle cx="11" cy="11" r="8" stroke="currentColor" fill="none" stroke-width="1.4"></circle><path d="m21 21-4.3-4.3" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_z2l0 api-wrapper"><div class="apiPage_KQrU"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><aside class="apiSidebarContainer_Korj"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/api/introduction"><span title="Introduction" class="linkLabel_WmDU">Introduction</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/api/get-auth-config"><span title="Platform" class="categoryLinkLabel_W154">Platform</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" href="/api/list-all-metrics"><span title="Metrics & Debugging" class="categoryLinkLabel_W154">Metrics & Debugging</span></a></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item api-method get"><a class="menu__link" tabindex="0" href="/api/list-all-metrics"><span title="List All Metrics" class="linkLabel_WmDU">List All Metrics</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item api-method get"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/api/performance-profile-json"><span title="Performance Profile JSON" class="linkLabel_WmDU">Performance Profile JSON</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item api-method get"><a class="menu__link" tabindex="0" href="/api/get-performance-profile"><span title="Get Performance Profile" class="linkLabel_WmDU">Get Performance Profile</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item api-method get"><a class="menu__link" tabindex="0" href="/api/get-dataflow-graph"><span title="Get Dataflow Graph" class="linkLabel_WmDU">Get Dataflow Graph</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item api-method get"><a class="menu__link" tabindex="0" href="/api/get-heap-profile"><span title="Get Heap Profile" class="linkLabel_WmDU">Get Heap Profile</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item api-method get"><a class="menu__link" tabindex="0" href="/api/stream-pipeline-logs"><span title="Stream Pipeline Logs" class="linkLabel_WmDU">Stream Pipeline Logs</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item api-method get"><a class="menu__link" tabindex="0" href="/api/get-pipeline-metrics"><span title="Get Pipeline Metrics" class="linkLabel_WmDU">Get Pipeline Metrics</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item api-method get"><a class="menu__link" tabindex="0" href="/api/get-samply-profile"><span title="Get Samply Profile" class="linkLabel_WmDU">Get Samply Profile</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item api-method post"><a class="menu__link" tabindex="0" href="/api/start-a-samply-profile"><span title="Start a Samply profile" class="linkLabel_WmDU">Start a Samply profile</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item api-method get"><a class="menu__link" tabindex="0" href="/api/get-pipeline-stats"><span title="Get Pipeline Stats" class="linkLabel_WmDU">Get Pipeline Stats</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item api-method get"><a class="menu__link" tabindex="0" href="/api/download-support-bundle"><span title="Download Support Bundle" class="linkLabel_WmDU">Download Support Bundle</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item api-method post"><a class="menu__link" tabindex="0" href="/api/test-endpoint"><span title="Test Endpoint" class="linkLabel_WmDU">Test Endpoint</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item api-method get"><a class="menu__link" tabindex="0" href="/api/get-time-series-stats"><span title="Get Time Series Stats" class="linkLabel_WmDU">Get Time Series Stats</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item api-method get"><a class="menu__link" tabindex="0" href="/api/stream-time-series"><span title="Stream Time Series" class="linkLabel_WmDU">Stream Time Series</span></a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/api/list-pipelines"><span title="Pipeline CRUD" class="categoryLinkLabel_W154">Pipeline CRUD</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/api/activate-standby-pipeline"><span title="Pipeline Lifecycle" class="categoryLinkLabel_W154">Pipeline Lifecycle</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/api/check-completion-status"><span title="Input Connectors" class="categoryLinkLabel_W154">Input Connectors</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/api/subscribe-to-view"><span title="Output Connectors" class="categoryLinkLabel_W154">Output Connectors</span></a></div></li></ul></nav></div></aside><main class="apiMainContainer_L2xG"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col"><div class="apiItemContainer_gBt2"><article><div class="theme-api-markdown markdown"><header><h1>Performance Profile JSON</h1></header>
<p>Retrieve the circuit performance profile in JSON format of a running or paused pipeline.</p>
<table style="display:table;width:100%"><thead><tr><th style="text-align:left">Path Parameters</th></tr></thead><tbody><tr><td><code>pipeline_name</code><span style="opacity:0.6"> string</span><span style="opacity:0.6"> — </span><strong style="font-size:var(--ifm-code-font-size);color:var(--openapi-required)"> REQUIRED</strong><div style="margin-top:var(--ifm-table-cell-padding)"><p>Unique pipeline name</p></div></td></tr></tbody></table>
<table style="display:table;width:100%"><thead><tr><th style="text-align:left">Responses</th></tr></thead><tbody><tr><td><div style="display:flex"><div style="margin-right:var(--ifm-table-cell-padding)"><code>200</code></div><div><p>Circuit performance profile in JSON format</p></div></div><div><table style="display:table;width:100%;margin-top:var(--ifm-table-cell-padding);margin-bottom:0px"><thead><tr><th style="text-align:left"><span>Schema </span><span style="opacity:0.6"> — </span><strong style="font-size:var(--ifm-code-font-size);color:var(--openapi-optional)"> OPTIONAL</strong><div></div></th></tr></thead><tbody><tr><td><span style="opacity:0.6"> object</span></td></tr></tbody></table></div></td></tr><tr><td><div style="display:flex"><div style="margin-right:var(--ifm-table-cell-padding)"><code>404</code></div><div><p>Pipeline with that name does not exist</p></div></div><div><table style="display:table;width:100%;margin-top:var(--ifm-table-cell-padding);margin-bottom:0px"><thead><tr><th style="text-align:left"><span>Schema </span><span style="opacity:0.6"> — </span><strong style="font-size:var(--ifm-code-font-size);color:var(--openapi-optional)"> OPTIONAL</strong><div></div></th></tr></thead><tbody><tr><td><code>details</code><span style="opacity:0.6"></span><div style="margin-top:var(--ifm-table-cell-padding)"><p>Detailed error metadata.
The contents of this field is determined by <code>error_code</code>.</p></div></td></tr><tr><td><code>error_code</code><span style="opacity:0.6"> string</span><div style="margin-top:var(--ifm-table-cell-padding)"><p>Error code is a string that specifies this error type.</p></div></td></tr><tr><td><code>message</code><span style="opacity:0.6"> string</span><div style="margin-top:var(--ifm-table-cell-padding)"><p>Human-readable error message.</p></div></td></tr></tbody></table></div></td></tr><tr><td><div style="display:flex"><div style="margin-right:var(--ifm-table-cell-padding)"><code>500</code></div><div></div></div><div><table style="display:table;width:100%;margin-top:var(--ifm-table-cell-padding);margin-bottom:0px"><thead><tr><th style="text-align:left"><span>Schema </span><span style="opacity:0.6"> — </span><strong style="font-size:var(--ifm-code-font-size);color:var(--openapi-optional)"> OPTIONAL</strong><div></div></th></tr></thead><tbody><tr><td><code>details</code><span style="opacity:0.6"></span><div style="margin-top:var(--ifm-table-cell-padding)"><p>Detailed error metadata.
The contents of this field is determined by <code>error_code</code>.</p></div></td></tr><tr><td><code>error_code</code><span style="opacity:0.6"> string</span><div style="margin-top:var(--ifm-table-cell-padding)"><p>Error code is a string that specifies this error type.</p></div></td></tr><tr><td><code>message</code><span style="opacity:0.6"> string</span><div style="margin-top:var(--ifm-table-cell-padding)"><p>Human-readable error message.</p></div></td></tr></tbody></table></div></td></tr><tr><td><div style="display:flex"><div style="margin-right:var(--ifm-table-cell-padding)"><code>503</code></div><div></div></div><div><table style="display:table;width:100%;margin-top:var(--ifm-table-cell-padding);margin-bottom:0px"><thead><tr><th style="text-align:left"><span>Schema </span><span style="opacity:0.6"> — </span><strong style="font-size:var(--ifm-code-font-size);color:var(--openapi-optional)"> OPTIONAL</strong><div></div></th></tr></thead><tbody><tr><td><code>details</code><span style="opacity:0.6"></span><div style="margin-top:var(--ifm-table-cell-padding)"><p>Detailed error metadata.
The contents of this field is determined by <code>error_code</code>.</p></div></td></tr><tr><td><code>error_code</code><span style="opacity:0.6"> string</span><div style="margin-top:var(--ifm-table-cell-padding)"><p>Error code is a string that specifies this error type.</p></div></td></tr><tr><td><code>message</code><span style="opacity:0.6"> string</span><div style="margin-top:var(--ifm-table-cell-padding)"><p>Human-readable error message.</p></div></td></tr></tbody></table></div></td></tr></tbody></table></div></article><nav class="pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/get-the-checkpoints-for-a-pipeline"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Get the checkpoints for a pipeline</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/get-performance-profile"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Get Performance Profile</div></a></nav></div></div><div class="col col--5"><div style="margin-top:3.5em"></div></div></div></div></main></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/get-started">Get Started</a></li><li class="footer__item"><a class="footer__link-item" href="/tutorials/basics/part1">Tutorial</a></li><li class="footer__item"><a class="footer__link-item" href="/sql/intro">SQL Reference</a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://join.slack.com/t/felderacommunity/shared_invite/zt-222bq930h-dgsu5IEzAihHg8nQt~dHzA" target="_blank" rel="noopener noreferrer" class="footer__link-item">Slack<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://discord.com/invite/s6t5n9UzHE" target="_blank" rel="noopener noreferrer" class="footer__link-item">Discord<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://bsky.app/profile/feldera.bsky.social" target="_blank" rel="noopener noreferrer" class="footer__link-item">Bluesky<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/feldera/feldera" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2026 Feldera Inc.</div></div></div></footer></div>
</body>
</html>