CINXE.COM

<!doctype html><html lang=en-US dir=ltr class="plugin-pages plugin-id-default" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.7.0"><title data-rh=true>Cognite Documentation</title><meta data-rh=true property=og:title content="Cognite Documentation"><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"><meta data-rh=true name=twitter:card content=summary_large_image><meta data-rh=true property=og:url content=https://docs.cognite.com/><meta data-rh=true property=og:locale content=en_US><meta data-rh=true property=og:locale:alternate content=de><meta data-rh=true property=og:locale:alternate content=fr><meta data-rh=true property=og:locale:alternate content=es><meta data-rh=true property=og:locale:alternate content=it><meta data-rh=true property=og:locale:alternate content=lv><meta data-rh=true property=og:locale:alternate content=nl><meta data-rh=true property=og:locale:alternate content=no><meta data-rh=true property=og:locale:alternate content=pt><meta data-rh=true property=og:locale:alternate content=ro><meta data-rh=true property=og:locale:alternate content=sv><meta data-rh=true property=og:locale:alternate content=ko><meta data-rh=true property=og:locale:alternate content=zh><meta data-rh=true property=og:locale:alternate content=ja><meta data-rh=true name=docusaurus_locale content=en-US><meta data-rh=true name=docusaurus_tag content=default><meta data-rh=true name=docsearch:language content=en-US><meta data-rh=true name=docsearch:docusaurus_tag content=default><meta data-rh=true name=description content="Documentation for Cognite Data Fusion (CDF) and our cloud-based apps and services"><meta data-rh=true property=og:description content="Documentation for Cognite Data Fusion (CDF) and our cloud-based apps and services"><link data-rh=true rel=icon href=/images/favicon.ico><link data-rh=true rel=canonical href=https://docs.cognite.com/><link data-rh=true rel=alternate href=https://docs.cognite.com/de/ hreflang=de><link data-rh=true rel=alternate href=https://docs.cognite.com/ hreflang=en-US><link data-rh=true rel=alternate href=https://docs.cognite.com/fr/ hreflang=fr><link data-rh=true rel=alternate href=https://docs.cognite.com/es/ hreflang=es><link data-rh=true rel=alternate href=https://docs.cognite.com/it/ hreflang=it><link data-rh=true rel=alternate href=https://docs.cognite.com/lv/ hreflang=lv><link data-rh=true rel=alternate href=https://docs.cognite.com/nl/ hreflang=nl><link data-rh=true rel=alternate href=https://docs.cognite.com/no/ hreflang=no><link data-rh=true rel=alternate href=https://docs.cognite.com/pt/ hreflang=pt><link data-rh=true rel=alternate href=https://docs.cognite.com/ro/ hreflang=ro><link data-rh=true rel=alternate href=https://docs.cognite.com/sv/ hreflang=sv><link data-rh=true rel=alternate href=https://docs.cognite.com/ko/ hreflang=ko><link data-rh=true rel=alternate href=https://docs.cognite.com/zh/ hreflang=zh><link data-rh=true rel=alternate href=https://docs.cognite.com/ja/ hreflang=ja><link data-rh=true rel=alternate href=https://docs.cognite.com/ hreflang=x-default><script data-rh=true>document.addEventListener("DOMContentLoaded",function(){void 0===window.docusaurus&&insertBanner()});function insertBanner(){var n=document.createElement("div");n.id="__docusaurus-base-url-issue-banner-container",n.innerHTML='\n<div id="__docusaurus-base-url-issue-banner" style="border: thick solid red; background-color: rgb(255, 230, 179); margin: 20px; padding: 20px; font-size: 20px;">\n <p style="font-weight: bold; font-size: 30px;">Your Docusaurus site did not load properly.</p>\n <p>A very common reason is a wrong site <a href="https://docusaurus.io/docs/docusaurus.config.js/#baseUrl" style="font-weight: bold;">baseUrl configuration</a>.</p>\n <p>Current configured baseUrl = <span style="font-weight: bold; color: red;">/</span> (default value)</p>\n <p>We suggest trying baseUrl = <span id="__docusaurus-base-url-issue-banner-suggestion-container" style="font-weight: bold; color: green;"></span></p>\n</div>\n',document.body.prepend(n);var e=document.getElementById("__docusaurus-base-url-issue-banner-suggestion-container"),s=window.location.pathname,o="/"===s.substr(-1)?s:s+"/";e.innerHTML=o}</script><link rel=preconnect href=https://www.google-analytics.com><link rel=preconnect href=https://www.googletagmanager.com><script async src="https://www.googletagmanager.com/gtag/js?id=G-B3DC1RG3B2"></script><script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-B3DC1RG3B2",{anonymize_ip:!0})</script><link rel=search type=application/opensearchdescription+xml title="Cognite Documentation" href=/opensearch.xml><link rel=stylesheet href=/assets/css/styles.b44d97bf.css><script src=/assets/js/runtime~main.a5a68d53.js defer></script><script src=/assets/js/main.50632d8f.js defer></script><body class=navigation-with-keyboard><script>!function(){var t,e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t=null!==e?e:"light",document.documentElement.setAttribute("data-theme",t)}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())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="navbar navbar--fixed-top"><div class=navbar__inner><div class="navbar__items navbar__items--left"><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"/></svg></button><a class="navbar__brand cog__brand" href=/><div class=navbar__logo><img src=/images/logos/cdf_logo_black.svg alt="Cognite Docs home" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src=/images/logos/cdf_logo_white.svg alt="Cognite Docs home" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div><b class="navbar__title text--truncate">Docs</b></a><div class="brandBorder_DKj8 cog-top-left-items"><a class="navbar__item navbar__link" href=/cdf/dashboards/>Analyze data</a><div class="navbar__item dropdown dropdown--hoverable"><a href=# aria-haspopup=true aria-expanded=false role=button class=navbar__link>Asset performance</a><ul class=dropdown__menu><li><a class=dropdown__link href=/infield_vnext/>InField</a><li><a class=dropdown__link href=/inrobot/>InRobot</a></ul></div><a class="navbar__item navbar__link" href=/cdf/atlas_ai/>Atlas AI</a><a class="navbar__item navbar__link" href=/cdf/data_engineering/>Data engineering</a><a class="navbar__item navbar__link" href=/cdf/admin/>Admin</a><a class="navbar__item navbar__link" href=/cdf/deploy/>Deploy</a></div></div><div class="navbar__items navbar__items--right"><div><div class="fedSearchBox_JRBG input-group"><img class=searchIco_LSr2 src=https://cognite-federatedsearch.azurewebsites.net/appbar/search.png><input placeholder="Search (Shift + K)" type=text class="searchBar_umxU form-control"></div></div><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href=# aria-haspopup=true aria-expanded=false role=button class=navbar__link><svg viewBox="0 0 24 24" width=20 height=20 aria-hidden=true class=iconLanguage_nlXk><path fill=currentColor d="M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"/></svg>English</a><ul class=dropdown__menu><li><a href=/de/ target=_self rel="noopener noreferrer" class=dropdown__link lang=de>Deutsch</a><li><a href=/ target=_self rel="noopener noreferrer" class="dropdown__link dropdown__link--active" lang=en-US>English</a><li><a href=/fr/ target=_self rel="noopener noreferrer" class=dropdown__link lang=fr>Français</a><li><a href=/es/ target=_self rel="noopener noreferrer" class=dropdown__link lang=es>Español</a><li><a href=/it/ target=_self rel="noopener noreferrer" class=dropdown__link lang=it>Italiano</a><li><a href=/lv/ target=_self rel="noopener noreferrer" class=dropdown__link lang=lv>Latviešu</a><li><a href=/nl/ target=_self rel="noopener noreferrer" class=dropdown__link lang=nl>Nederlands</a><li><a href=/no/ target=_self rel="noopener noreferrer" class=dropdown__link lang=no>Norsk</a><li><a href=/pt/ target=_self rel="noopener noreferrer" class=dropdown__link lang=pt>Português</a><li><a href=/ro/ target=_self rel="noopener noreferrer" class=dropdown__link lang=ro>Română</a><li><a href=/sv/ target=_self rel="noopener noreferrer" class=dropdown__link lang=sv>Svenska</a><li><a href=/ko/ target=_self rel="noopener noreferrer" class=dropdown__link lang=ko>한국어</a><li><a href=/zh/ target=_self rel="noopener noreferrer" class=dropdown__link lang=zh>中文</a><li><a href=/ja/ target=_self rel="noopener noreferrer" class=dropdown__link lang=ja>日本語</a></ul></div><div class=AppSwitcher_EB5n><div class="cog-app-menu-list dropdown"><a aria-haspopup=true href=# class=nav-link aria-expanded=false><img class=searchIco_LSr2 src=https://cognite-federatedsearch.azurewebsites.net/appbar/app.png></a><div tabindex=-1 role=menu aria-hidden=true class="dropDownMenu_hxO_ dropdown-menu"><a href=https://hub.cognite.com/ tabindex=0 role=menuitem class=dropdown-item><img src=https://cognite-federatedsearch.azurewebsites.net/appbar/ask.png> Cognite Hub <img class=dropDownIcoRight_YVee src=https://cognite-federatedsearch.azurewebsites.net/appbar/open.png></a><a href=https://learn.cognite.com/ tabindex=0 role=menuitem class=dropdown-item><img src=https://cognite-federatedsearch.azurewebsites.net/appbar/academy.png> Cognite Academy <img class=dropDownIcoRight_YVee src=https://cognite-federatedsearch.azurewebsites.net/appbar/open.png></a><a href=https://status.cognite.com/ tabindex=0 role=menuitem class=dropdown-item><img src=https://cognite-federatedsearch.azurewebsites.net/appbar/statuspage.png> Cognite status page <img class=dropDownIcoRight_YVee src=https://cognite-federatedsearch.azurewebsites.net/appbar/open.png></a><a href=https://cognite.zendesk.com/hc/en-us/requests/new tabindex=0 role=menuitem class=dropdown-item><img src=https://cognite-federatedsearch.azurewebsites.net/appbar/support.png> Cognite support <img class=dropDownIcoRight_YVee src=https://cognite-federatedsearch.azurewebsites.net/appbar/open.png></a><div tabindex=-1 class=dropdown-divider></div><h6 tabindex=-1 class=dropdown-header>Cognite website</h6><a href=https://www.cognite.com/ target=_blank tabindex=0 role=menuitem class=dropdown-item>www.cognite.com<img class=dropDownIcoRight_YVee src=https://cognite-federatedsearch.azurewebsites.net/appbar/open.png></a></div></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="main-wrapper mainWrapper_z2l0"><main><img class=heroBanner_qdFl alt=""><div class=holder_Yzc4><h1 class=title_GqtP>Cognite documentation</h1><p class=desc_1LEm>Self-service product documentation for developers <br> and technology professionals.</div><section class=bannerHolder_Aj1b><div class="largeScreenContainer_Y1vU container"><div class=slider_ff8P><div class="row col container bannerCards_Tpke"><a class=links_dyGv href=/cdf/><div class="svgIcon_RsGV row"><img class=svgholder_z0HS src=https://apps-cdn.cogniteapp.com/@cognite/docs-portal-images/1.0.0/images/homePage/iconMaintain.svg></div><div class="row bannerInfo info_tyYC"><h2>Cognite Data Fusion</h2><p>Learn how you can use Cognite Data Fusion (CDF) to contextualize and analyze your technical data in the cloud and efficiently manage and use your information and insights.</div></a></div><div class="row col container bannerCards_Tpke"><a class=links_dyGv href=/infield_vnext><div class="svgIcon_RsGV row"><img class=svgholder_z0HS src=https://apps-cdn.cogniteapp.com/@cognite/docs-portal-images/1.0.0/images/homePage/iconInField.svg></div><div class="row bannerInfo info_tyYC"><h2>InField</h2><p>Cognite InField helps you plan, schedule, and assign activities to perform operator rounds and implement work orders.</div></a></div><div class="row col container bannerCards_Tpke"><a class=links_dyGv href=/inrobot/><div class="svgIcon_RsGV row"><img class=svgholder_z0HS src=../images/homePage/AppCardInRobot.png></div><div class="row bannerInfo info_tyYC"><h2>InRobot</h2><p>Cognite InRobot helps you deploy and manage robots to automate data collection and equipment inspection.</div></a></div></div><div class=noslider_w5PX><div class="row col container bannerCards_Tpke"><a class=links_dyGv href=/cdf/><div class="svgIcon_RsGV row"><img class=svgholder_z0HS src=https://apps-cdn.cogniteapp.com/@cognite/docs-portal-images/1.0.0/images/homePage/iconMaintain.svg></div><div class="row bannerInfo info_tyYC"><h2>Cognite Data Fusion</h2><p>Learn how you can use Cognite Data Fusion (CDF) to contextualize and analyze your technical data in the cloud and efficiently manage and use your information and insights.</div></a></div><div class="row col container bannerCards_Tpke"><a class=links_dyGv href=/infield_vnext><div class="svgIcon_RsGV row"><img class=svgholder_z0HS src=https://apps-cdn.cogniteapp.com/@cognite/docs-portal-images/1.0.0/images/homePage/iconInField.svg></div><div class="row bannerInfo info_tyYC"><h2>InField</h2><p>Cognite InField helps you plan, schedule, and assign activities to perform operator rounds and implement work orders.</div></a></div><div class="row col container bannerCards_Tpke"><a class=links_dyGv href=/inrobot/><div class="svgIcon_RsGV row"><img class=svgholder_z0HS src=../images/homePage/AppCardInRobot.png></div><div class="row bannerInfo info_tyYC"><h2>InRobot</h2><p>Cognite InRobot helps you deploy and manage robots to automate data collection and equipment inspection.</div></a></div></div></div></section><section class=features_u2OU><div class="largeScreenContainer_hjAI container"><p class=titleT3_INw5> <div class=slider_gnrs><div class="col col--3 holder_qnFB"><a href=https://developer.cognite.com/dev/ target=_blank rel="noopener noreferrer" class=links_S5QL><div class=imageHolder_J42e><img></div><div><img class=icons_eLaJ src=../images/homePage/Dev.svg><span class=title_ZnOs>Developers</span><p class=desc_F8wT>Get familiar with our open API and SDKs and explore their features. Develop applications and machine learning models that match your operational needs.</div></a></div><div class="col col--3 holder_qnFB"><a class=links_S5QL href=/cdf/data_engineering><div class=imageHolder_J42e><img></div><div><img class=icons_eLaJ src=../images/homePage/KeyConcepts.svg><span class=title_ZnOs>Data engineers</span><p class=desc_F8wT>Learn how to model, integrate, transform, and consolidate data to design and support high-performing, efficient, and reliable data pipelines.</div></a></div><div class="col col--3 holder_qnFB"><a class=links_S5QL href=/cdf/admin><div class=imageHolder_J42e><img></div><div><img class=icons_eLaJ src=../images/homePage/Bulb.svg><span class=title_ZnOs>Administrators</span><p class=desc_F8wT>See how to manage access to CDF, configure apps and solutions, and learn about new and deprecated features to prepare for future CDF releases.</div></a></div><div class="col col--3 holder_qnFB"><a href=https://developer.cognite.com/api/ target=_blank rel="noopener noreferrer" class=links_S5QL><div class=imageHolder_J42e><img></div><div><img class=icons_eLaJ src=../images/homePage/api.png><span class=title_ZnOs>API reference</span><p class=desc_F8wT>See the reference documentation for the Cognite API with details and overview information for all available methods.</div></a></div></div><div class=noslider_J0ko><div class="col col--3 holder_qnFB"><a href=https://developer.cognite.com/dev/ target=_blank rel="noopener noreferrer" class=links_S5QL><div class=imageHolder_J42e><img></div><div><img class=icons_eLaJ src=../images/homePage/Dev.svg><span class=title_ZnOs>Developers</span><p class=desc_F8wT>Get familiar with our open API and SDKs and explore their features. Develop applications and machine learning models that match your operational needs.</div></a></div><div class="col col--3 holder_qnFB"><a class=links_S5QL href=/cdf/data_engineering><div class=imageHolder_J42e><img></div><div><img class=icons_eLaJ src=../images/homePage/KeyConcepts.svg><span class=title_ZnOs>Data engineers</span><p class=desc_F8wT>Learn how to model, integrate, transform, and consolidate data to design and support high-performing, efficient, and reliable data pipelines.</div></a></div><div class="col col--3 holder_qnFB"><a class=links_S5QL href=/cdf/admin><div class=imageHolder_J42e><img></div><div><img class=icons_eLaJ src=../images/homePage/Bulb.svg><span class=title_ZnOs>Administrators</span><p class=desc_F8wT>See how to manage access to CDF, configure apps and solutions, and learn about new and deprecated features to prepare for future CDF releases.</div></a></div><div class="col col--3 holder_qnFB"><a href=https://developer.cognite.com/api/ target=_blank rel="noopener noreferrer" class=links_S5QL><div class=imageHolder_J42e><img></div><div><img class=icons_eLaJ src=../images/homePage/api.png><span class=title_ZnOs>API reference</span><p class=desc_F8wT>See the reference documentation for the Cognite API with details and overview information for all available methods.</div></a></div></div></div></section></main></div><footer class="footer footer--dark cog-footer-dark"><div class="container container-fluid cog-footer"><div class="row footer__links"><div class="col footer__col"><div class=footer__title>E-learning</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://learn.cognite.com/ target=_blank rel="noopener noreferrer" class=footer__link-item>Cognite Academy<svg width=13.5 height=13.5 aria-hidden=true viewBox="0 0 24 24" class=iconExternalLink_nPIU><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"/></svg></a></ul></div><div class="col footer__col"><div class=footer__title>Community</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://hub.cognite.com/ target=_blank rel="noopener noreferrer" class=footer__link-item>Cognite Hub<svg width=13.5 height=13.5 aria-hidden=true viewBox="0 0 24 24" class=iconExternalLink_nPIU><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"/></svg></a></ul></div><div class="col footer__col"><div class=footer__title>Support</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://cognite.zendesk.com/hc/en-us target=_blank rel="noopener noreferrer" class=footer__link-item>Cognite Support<svg width=13.5 height=13.5 aria-hidden=true viewBox="0 0 24 24" class=iconExternalLink_nPIU><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"/></svg></a></ul></div><div class="col footer__col"><div class=footer__title>Legal</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://www.cognite.com/en/generalterms target=_blank rel="noopener noreferrer" class=footer__link-item>Terms and conditions<svg width=13.5 height=13.5 aria-hidden=true viewBox="0 0 24 24" class=iconExternalLink_nPIU><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"/></svg></a></ul></div></div><div class=footer__bottom><div class=margin-bottom--sm><img src=/images/logos/cogfooter.svg class="footer__logo cog-footer-logo themedComponent_mlkZ themedComponent--light_NVdE" width=32 height=32><img src=/images/logos/cogfooter.svg class="footer__logo cog-footer-logo themedComponent_mlkZ themedComponent--dark_xIcU" width=32 height=32></div></div></div></footer></div>