{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Datafold","colors":{"primary":"#3d75ff","light":"#3d75ff","dark":"#3d75ff"},"logo":"https://mintcdn.com/datafold/4ZNRDufNo9R1p08Q/logo/datafold_logo.png?fit=max\u0026auto=format\u0026n=4ZNRDufNo9R1p08Q\u0026q=85\u0026s=d2d28c3f09cecdfeb1086040b11f50c8","favicon":"https://mintcdn.com/datafold/7pWtpSckJi2T0xZR/favicon.png?fit=max\u0026auto=format\u0026n=7pWtpSckJi2T0xZR\u0026q=85\u0026s=42812fe3d36148668be5e38a44dbc9c0","background":{"decoration":"gradient"},"navbar":{"links":[{"href":"https://us.datafold.com/login","label":"Login"}],"primary":{"type":"button","label":"Request a Demo","href":"https://www.datafold.com/demo"}},"footer":{"socials":{"linkedin":"https://get.datafold.com/linkedin","x":"https://get.datafold.com/twitter","github":"https://github.com/datafold/data-diff","youtube":"https://get.datafold.com/youtube"}},"integrations":{"gtm":{"tagId":"GTM-W3G3TXJ"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"About Datafold","icon":{"style":"duotone","name":"house"},"href":"https://www.datafold.com/"},{"anchor":"Blog","icon":{"style":"duotone","name":"pen"},"href":"https://www.datafold.com/blog?"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"datafold","hasAudioNarration":false,"actualSubdomain":"datafold","customDomains":["docs.datafold.com"],"gitSource":{"type":"github","owner":"datafold","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af7d6ebfc54013c2f3f8ff5","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"Documentation","count":192},{"language":"default","tag":"INTEGRATIONS","count":96},{"language":"default","tag":"API Reference","count":89},{"language":"default","tag":"Databases","count":40},{"language":"default","tag":"SECURITY","count":28},{"language":"default","tag":"Monitors","count":25},{"language":"default","tag":"DATA DIFFS","count":20},{"language":"default","tag":"LLM Providers","count":20},{"language":"default","tag":"Frequently Asked Questions","count":17},{"language":"default","tag":"FAQ","count":17}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"rbac-expansion","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":"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":"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":"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":"editor-metadata","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},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","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}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":"@font-face{font-family:'Poppins';src:url('chrome-extension://opafjjlpbiaicbbgifbejoochmmeikep/fonts/Poppins-Medium.woff');font-weight:400;font-style:normal;font-display:swap}h5.pl-4.mb-3\\.5.lg\\:mb-2\\.5.font-semibold{font-size:0.75rem;margin-top:0rem;margin-bottom:0rem;padding-left:1rem}"}],"page":{"pagePath":"api-reference/monitors/list-monitors","slug":"/api-reference/monitors/list-monitors","pageMetadata":{"openapi":"openapi-butterfly.json get /api/v1/monitors","description":"List data diff monitors via the Datafold API.","title":"List monitors","href":"/api-reference/monitors/list-monitors"},"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: \"List data diff monitors via the Datafold API.\"\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"openapi-butterfly.json get /api/v1/monitors","description":"List data diff monitors via the Datafold API.","title":"List monitors","href":"/api-reference/monitors/list-monitors"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/datafold/d7bd0b948766e6b9/script.js","/_mintlify/custom/datafold/8c81f551ba77e4ad/login-link.js"],"openApiReferenceData":{"operation":{"operationId":"list_monitors_api_v1_monitors_get","parameters":["3182cf3c-8886-47f5-944d-261eafbd05c4","c9f3a7fb-d52d-4cb9-b0c4-5cd81924bab2","9f629f87-e543-46ff-8cb2-41788609ed29","d7b5947e-865d-4cab-a203-205451a18a6a","3cd1f553-e3cc-4307-84cb-9617a67b621a","3f2c1ff9-700e-4bfd-a33a-32324dad0014"],"responses":{"200":"770b5628-0679-4ceb-8149-6b9bc0afe217","422":"17f0567b-a9b1-45a6-9ecb-1f9f44fbcfa4"},"summary":"List monitors","tags":["Monitors"],"method":"get","type":"path","servers":["d68a8016-a4de-4d05-b341-ce8a8275a3e9","043eb1aa-e2e6-435f-ad37-754296e4b776"],"security":["1ae879b0-833b-41ae-8c1e-8bcfe8af5358"],"path":"/api/v1/monitors","baseUrlOptions":["https://us.datafold.com","https://eub.datafold.com"],"title":"List monitors","description":"List data diff monitors via the Datafold API.","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"3182cf3c-8886-47f5-944d-261eafbd05c4":{"description":"The page number to retrieve.","in":"query","name":"page","required":false,"schema":{"default":1,"description":"The page number to retrieve.","minimum":1,"title":"Page","type":"integer","isRequired":false,"uniqueKey":"","typeLabel":"integer"}},"c9f3a7fb-d52d-4cb9-b0c4-5cd81924bab2":{"description":"The number of monitors per page.","in":"query","name":"page_size","required":false,"schema":{"default":20,"description":"The number of monitors per page.","maximum":200,"minimum":1,"title":"Page Size","type":"integer","isRequired":false,"uniqueKey":"","typeLabel":"integer"}},"9f629f87-e543-46ff-8cb2-41788609ed29":{"description":"Field to order the monitors by.","in":"query","name":"order_by","required":false,"schema":{"default":"id","description":"Field to order the monitors by.","enum":["id","name","created_at","updated_at","last_run_at"],"title":"Order By","type":"string","isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>"}},"d7b5947e-865d-4cab-a203-205451a18a6a":{"description":"Order direction.","in":"query","name":"sort_order","required":false,"schema":{"default":"desc","description":"Order direction.","enum":["asc","desc"],"title":"Sort Order","type":"string","isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>"}},"3cd1f553-e3cc-4307-84cb-9617a67b621a":{"description":"Comma-separated tags; a monitor must carry all of them to match.","in":"query","name":"tags","required":false,"schema":{"oneOf":[{"type":"string","title":"Tags","description":"Comma-separated tags; a monitor must carry all of them to match.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Tags","description":"Comma-separated tags; a monitor must carry all of them to match.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"3f2c1ff9-700e-4bfd-a33a-32324dad0014":{"description":"Filter by whether the schedule fires.","in":"query","name":"enabled","required":false,"schema":{"oneOf":[{"type":"boolean","title":"Enabled","description":"Filter by whether the schedule fires.","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Enabled","description":"Filter by whether the schedule fires.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean | null"}}},"responses":{"770b5628-0679-4ceb-8149-6b9bc0afe217":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"Total number of monitors visible to the caller.","title":"Count","type":"integer","isRequired":true,"uniqueKey":"count","typeLabel":"integer"},"monitors":{"description":"This page of monitors.","items":{"properties":{"created_at":{"description":"When the monitor was created.","format":"date-time","title":"Created At","type":"string","isRequired":true,"uniqueKey":"monitors.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"enabled":{"description":"Whether the schedule fires.","title":"Enabled","type":"boolean","isRequired":true,"uniqueKey":"monitors.items.[INDEX].enabled","typeLabel":"boolean"},"id":{"description":"Unique identifier for the monitor.","title":"Id","type":"integer","isRequired":true,"uniqueKey":"monitors.items.[INDEX].id","typeLabel":"integer"},"managed_in_code":{"description":"True when the monitor's definition lives in a repo. Update and delete are refused for such a monitor — change its YAML instead.","title":"Managed In Code","type":"boolean","isRequired":true,"uniqueKey":"monitors.items.[INDEX].managed_in_code","typeLabel":"boolean"},"modified_at":{"description":"When the monitor was last modified.","format":"date-time","title":"Modified At","type":"string","isRequired":true,"uniqueKey":"monitors.items.[INDEX].modified_at","typeLabel":"string\u003cdate-time>"},"monitor_type":{"const":"diff","description":"Type of the monitor.","title":"Monitor Type","type":"string","isRequired":true,"uniqueKey":"monitors.items.[INDEX].monitor_type","typeLabel":"string"},"name":{"oneOf":[{"type":"string","title":"Name","description":"Name of the monitor.","isRequired":true,"uniqueKey":"monitors.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","description":"Name of the monitor.","isRequired":true,"uniqueKey":"monitors.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"monitors.items.[INDEX].name","typeLabel":"string | null"},"last_run":{"oneOf":[{"type":"string","title":"Last Run","description":"When the monitor last started a run.","format":"date-time","uniqueKey":"monitors.items.[INDEX].last_run.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Last Run","description":"When the monitor last started a run.","uniqueKey":"monitors.items.[INDEX].last_run.oneOf.1","typeLabel":"null"}],"uniqueKey":"monitors.items.[INDEX].last_run","typeLabel":"string\u003cdate-time> | null"},"next_run":{"oneOf":[{"type":"string","title":"Next Run","description":"When the schedule fires next.","format":"date-time","uniqueKey":"monitors.items.[INDEX].next_run.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Next Run","description":"When the schedule fires next.","uniqueKey":"monitors.items.[INDEX].next_run.oneOf.1","typeLabel":"null"}],"uniqueKey":"monitors.items.[INDEX].next_run","typeLabel":"string\u003cdate-time> | null"},"owner":{"oneOf":[{"type":"string","title":"Owner","description":"Email of the monitor owner.","uniqueKey":"monitors.items.[INDEX].owner.oneOf.0","typeLabel":"string"},{"type":"null","title":"Owner","description":"Email of the monitor owner.","uniqueKey":"monitors.items.[INDEX].owner.oneOf.1","typeLabel":"null"}],"uniqueKey":"monitors.items.[INDEX].owner","typeLabel":"string | null"},"slug":{"oneOf":[{"type":"string","title":"Slug","description":"Stable identifier.","uniqueKey":"monitors.items.[INDEX].slug.oneOf.0","typeLabel":"string"},{"type":"null","title":"Slug","description":"Stable identifier.","uniqueKey":"monitors.items.[INDEX].slug.oneOf.1","typeLabel":"null"}],"uniqueKey":"monitors.items.[INDEX].slug","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","title":"MonitorRunState","description":"Outcome of the latest run, once it has one.","enum":["ok","alert","error","cancelled"],"uniqueKey":"monitors.items.[INDEX].state.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Outcome of the latest run, once it has one.","uniqueKey":"monitors.items.[INDEX].state.oneOf.1","typeLabel":"null"}],"uniqueKey":"monitors.items.[INDEX].state","typeLabel":"enum\u003cstring> | null"},"tags":{"description":"Tags on the monitor.","items":{"type":"string","uniqueKey":"monitors.items.[INDEX].tags.items.[INDEX]","typeLabel":"string"},"title":"Tags","type":"array","uniqueKey":"monitors.items.[INDEX].tags","typeLabel":"string[]"}},"required":["id","name","monitor_type","created_at","modified_at","enabled","managed_in_code"],"title":"ApiPublicGetMonitorOut","type":"object","uniqueKey":"monitors.items.[INDEX]","typeLabel":"ApiPublicGetMonitorOut · object"},"title":"Monitors","type":"array","isRequired":true,"uniqueKey":"monitors","typeLabel":"ApiPublicGetMonitorOut · object[]"},"page":{"description":"Current page number.","title":"Page","type":"integer","isRequired":true,"uniqueKey":"page","typeLabel":"integer"},"page_size":{"description":"Monitors per page.","title":"Page Size","type":"integer","isRequired":true,"uniqueKey":"page_size","typeLabel":"integer"},"total_pages":{"description":"Total number of pages.","title":"Total Pages","type":"integer","isRequired":true,"uniqueKey":"total_pages","typeLabel":"integer"}},"required":["count","monitors","page","page_size","total_pages"],"title":"ApiPublicListMonitorsOut","type":"object","uniqueKey":"","typeLabel":"ApiPublicListMonitorsOut · object"},"examples":{"Example":{"title":"Example","value":{"count":123,"monitors":[{"created_at":"2023-11-07T05:31:56Z","enabled":true,"id":123,"managed_in_code":true,"modified_at":"2023-11-07T05:31:56Z","monitor_type":"diff","name":"\u003cstring>","last_run":"2023-11-07T05:31:56Z","next_run":"2023-11-07T05:31:56Z","owner":"\u003cstring>","slug":"\u003cstring>","state":"ok","tags":["\u003cstring>"]}],"page":123,"page_size":123,"total_pages":123}}},"exampleType":"generated"}},"description":"Successful Response","exampleType":"generated"},"17f0567b-a9b1-45a6-9ecb-1f9f44fbcfa4":{"content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"title":"Location","type":"array","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"title":"Error Type","type":"string","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"},"ctx":{"title":"Context","type":"object","uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"}},"required":["loc","msg","type"],"title":"ValidationError","type":"object","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"title":"Detail","type":"array","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"title":"HTTPValidationError","type":"object","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>","ctx":{},"input":"\u003cunknown>"}]}}},"exampleType":"generated"}},"description":"Validation Error","exampleType":"generated"}},"security":{"1ae879b0-833b-41ae-8c1e-8bcfe8af5358":{"ApiKeyAuth":{"description":"Use the 'Authorization' header with the format 'Key \u003capi-key>'","in":"header","name":"Authorization","type":"apiKey","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"d68a8016-a4de-4d05-b341-ce8a8275a3e9":{"url":"https://us.datafold.com","description":"US"},"043eb1aa-e2e6-435f-ad37-754296e4b776":{"url":"https://eub.datafold.com","description":"EU"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"description":"Use the 'Authorization' header with the format 'Key \u003capi-key>'","in":"header","name":"Authorization","type":"apiKey","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"Authorization","type":"string","description":"Use the 'Authorization' header with the format 'Key \u003capi-key>'","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi-butterfly.json"},"subdomain":"datafold","siteName":"Datafold","title":"List monitors - Datafold","navMaps":{"firstHrefInVersion":{"Current version":{"href":"/api-reference/monitors/list-monitors","matchLevel":0},"Classic version":{"href":"/classic/api-reference/monitors/list-monitors","matchLevel":1}},"firstHrefInLanguage":{}},"lastModified":"2026-11-14T03:35:21.022Z","originalFileLocation":"api-reference/monitors/list-monitors.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=\"system\"}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=\"List data diff monitors via the Datafold API.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Datafold\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/datafold/EdEzedhhtpnvEoZM/_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/datafold/EdEzedhhtpnvEoZM/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/datafold/EdEzedhhtpnvEoZM/_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/datafold/EdEzedhhtpnvEoZM/_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/datafold/EdEzedhhtpnvEoZM/_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/datafold/EdEzedhhtpnvEoZM/_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/datafold/EdEzedhhtpnvEoZM/_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/datafold/EdEzedhhtpnvEoZM/_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/datafold/EdEzedhhtpnvEoZM/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List monitors - Datafold\">\u003cmeta data-mint-head property=\"og:description\" content=\"List data diff monitors via the Datafold API.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Datafold\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.datafold.com/api-reference/monitors/list-monitors\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://datafold.mintlify.site/_mintlify/api/og/v2?division=Monitors\u0026amp;title=List+monitors\u0026amp;description=List+data+diff+monitors+via+the+Datafold+API.\u0026amp;theme=7ca6f7d7c4ed7ec3d831e6bf\u0026amp;signature=78c1fcf911fb8133d18e56c1a63f987a43b9f858af6920330e25bcbc6e092d14\">\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=\"List monitors - Datafold\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"List data diff monitors via the Datafold API.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://datafold.mintlify.site/_mintlify/api/og/v2?division=Monitors\u0026amp;title=List+monitors\u0026amp;description=List+data+diff+monitors+via+the+Datafold+API.\u0026amp;theme=7ca6f7d7c4ed7ec3d831e6bf\u0026amp;signature=78c1fcf911fb8133d18e56c1a63f987a43b9f858af6920330e25bcbc6e092d14\">\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/datafold/EdEzedhhtpnvEoZM/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Datafold\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3d75ff\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.datafold.com/api-reference/monitors/list-monitors\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/monitors/list-monitors.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.datafold.com/#organization\",\"name\":\"Datafold\",\"url\":\"https://docs.datafold.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/datafold/4ZNRDufNo9R1p08Q/logo/datafold_logo.png?fit=max\u0026auto=format\u0026n=4ZNRDufNo9R1p08Q\u0026q=85\u0026s=d2d28c3f09cecdfeb1086040b11f50c8\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.datafold.com#website\",\"name\":\"Datafold\",\"url\":\"https://docs.datafold.com\",\"publisher\":{\"@id\":\"https://docs.datafold.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.datafold.com/api-reference/monitors/list-monitors#webpage\",\"url\":\"https://docs.datafold.com/api-reference/monitors/list-monitors\",\"name\":\"List monitors\",\"description\":\"List data diff monitors via the Datafold API.\",\"dateModified\":\"2026-11-14T03:35:21.022Z\",\"isPartOf\":{\"@id\":\"https://docs.datafold.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.datafold.com/api-reference/monitors/list-monitors#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.datafold.com/api-reference/monitors/list-monitors#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Cloud\",\"item\":\"https://docs.datafold.com/api-reference/datafold-api\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Datafold API\",\"item\":\"https://docs.datafold.com/api-reference/datafold-api\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"List monitors\",\"item\":\"https://docs.datafold.com/api-reference/monitors/list-monitors\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.datafold.com/api-reference/monitors/list-monitors#apireference\",\"headline\":\"List monitors\",\"name\":\"List monitors\",\"description\":\"List data diff monitors via the Datafold API.\",\"url\":\"https://docs.datafold.com/api-reference/monitors/list-monitors\",\"mainEntityOfPage\":{\"@id\":\"https://docs.datafold.com/api-reference/monitors/list-monitors#webpage\"},\"dateModified\":\"2026-11-14T03:35:21.022Z\",\"publisher\":{\"@id\":\"https://docs.datafold.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.datafold.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Datafold\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Datafold\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/monitors/list-monitors.md","siteName":"Datafold","nav":{"global":{"anchors":[{"anchor":"About Datafold","icon":{"style":"duotone","name":"house"},"href":"https://www.datafold.com/"},{"anchor":"Blog","icon":{"style":"duotone","name":"pen"},"href":"https://www.datafold.com/blog?"}]},"versions":[{"version":"Current version","default":true,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/welcome"}]},{"tab":"API Reference","groups":[{"group":"Cloud","pages":[{"group":"Datafold API","pages":[{"title":"Datafold API","href":"/api-reference/datafold-api"},{"title":"Introduction","href":"/api-reference/introduction"},{"title":"MCP Server","href":"/api-reference/mcp-server-setup"},{"group":"Data Sources","pages":[{"openapi":"openapi-butterfly.json get /api/v1/data_sources","title":"List data sources","href":"/api-reference/data-sources/list-data-sources"},{"openapi":"openapi-butterfly.json post /api/v1/data_sources","title":"Create a data source","href":"/api-reference/data-sources/create-a-data-source"},{"openapi":"openapi-butterfly.json get /api/v1/data_sources/test/{job_id}","title":"Get data source testing results","href":"/api-reference/data-sources/get-data-source-testing-results"},{"openapi":"openapi-butterfly.json get /api/v1/data_sources/types","title":"List data source types","href":"/api-reference/data-sources/list-data-source-types"},{"openapi":"openapi-butterfly.json get /api/v1/data_sources/{data_source_id}","title":"Get a data source","href":"/api-reference/data-sources/get-a-data-source"},{"openapi":"openapi-butterfly.json get /api/v1/data_sources/{data_source_id}/summary","title":"Get a data source summary","href":"/api-reference/data-sources/get-a-data-source-summary"},{"openapi":"openapi-butterfly.json post /api/v1/data_sources/{data_source_id}/test","title":"Test a data source connection","href":"/api-reference/data-sources/test-a-data-source-connection"},{"openapi":"openapi-butterfly.json post /api/v1/data_sources/{data_source_id}/query","title":"Execute a SQL query against a data source","href":"/api-reference/data-sources/execute-a-sql-query-against-a-data-source"}]},{"group":"Data Diffs","pages":[{"openapi":"openapi-butterfly.json get /api/v1/datadiffs","title":"List data diffs","href":"/api-reference/data-diffs/list-data-diffs"},{"openapi":"openapi-butterfly.json post /api/v1/datadiffs","title":"Create a data diff","href":"/api-reference/data-diffs/create-a-data-diff"},{"openapi":"openapi-butterfly.json get /api/v1/datadiffs/{datadiff_id}","title":"Get a data diff","href":"/api-reference/data-diffs/get-a-data-diff"},{"openapi":"openapi-butterfly.json patch /api/v1/datadiffs/{datadiff_id}","title":"Update a data diff","href":"/api-reference/data-diffs/update-a-data-diff"},{"openapi":"openapi-butterfly.json get /api/v1/datadiffs/{datadiff_id}/summary_results","title":"Get a data diff summary","href":"/api-reference/data-diffs/get-a-data-diff-summary"},{"openapi":"openapi-butterfly.json get /api/v1/datadiffs/{datadiff_id}/summary","title":"Get a human-readable summary of a DataDiff comparison","href":"/api-reference/data-diffs/get-a-data-diff-summary-overview"},{"openapi":"openapi-butterfly.json post /api/v1/datadiffs/{datadiff_id}/cancel","description":"Cancel a running data diff via the Datafold API.","title":"Cancel a running data diff","href":"/api-reference/data-diffs/cancel-a-running-data-diff"}]},{"group":"Monitors","pages":[{"openapi":"openapi-butterfly.json get /api/v1/monitors","title":"List monitors","href":"/api-reference/monitors/list-monitors"},{"openapi":"openapi-butterfly.json get /api/v1/monitors/{id}","description":"Get a data diff monitor via the Datafold API.","title":"Get a monitor","href":"/api-reference/monitors/get-monitor"},{"openapi":"openapi-butterfly.json post /api/v1/monitors/create/diff","title":"Create a data diff monitor","href":"/api-reference/monitors/create-a-data-diff-monitor"},{"openapi":"openapi-butterfly.json patch /api/v1/monitors/{id}/update","title":"Update a monitor","href":"/api-reference/monitors/update-a-monitor"},{"openapi":"openapi-butterfly.json put /api/v1/monitors/{id}/toggle","title":"Enable or disable a monitor","href":"/api-reference/monitors/toggle-a-monitor"},{"openapi":"openapi-butterfly.json delete /api/v1/monitors/{id}","title":"Delete a monitor","href":"/api-reference/monitors/delete-a-monitor"},{"openapi":"openapi-butterfly.json post /api/v1/monitors/{id}/run","title":"Trigger a run","href":"/api-reference/monitors/trigger-a-run"},{"openapi":"openapi-butterfly.json get /api/v1/monitors/{id}/runs","title":"List a monitor's runs","href":"/api-reference/monitors/list-monitor-runs"},{"openapi":"openapi-butterfly.json get /api/v1/monitors/{id}/runs/{run_id}","title":"Get a monitor run","href":"/api-reference/monitors/get-monitor-run"}]},{"group":"Audit Logs","pages":[{"openapi":"openapi-butterfly.json get /api/v1/audit_logs","title":"Get Audit Logs","href":"/api-reference/audit-logs/get-audit-logs"}]}]}]},{"group":"Audit Logs","pages":[{"openapi":"openapi-butterfly.json get /api/v1/audit_logs","title":"Get Audit Logs","href":"/api-reference/audit-logs/get-audit-logs"}]},{"group":"Data sources","pages":[{"openapi":"openapi-butterfly.json get /api/v1/data_sources","title":"List data sources","href":"/api-reference/data-sources/list-data-sources"},{"openapi":"openapi-butterfly.json post /api/v1/data_sources","title":"Create a data source","href":"/api-reference/data-sources/create-a-data-source"},{"openapi":"openapi-butterfly.json get /api/v1/data_sources/test/{job_id}","title":"Get data source testing results","href":"/api-reference/data-sources/get-data-source-testing-results"},{"openapi":"openapi-butterfly.json get /api/v1/data_sources/types","title":"List data source types","href":"/api-reference/data-sources/list-data-source-types"},{"openapi":"openapi-butterfly.json get /api/v1/data_sources/{data_source_id}","title":"Get a data source","href":"/api-reference/data-sources/get-a-data-source"},{"openapi":"openapi-butterfly.json post /api/v1/data_sources/{data_source_id}/query","title":"Execute a SQL query against a data source","href":"/api-reference/data-sources/execute-a-sql-query-against-a-data-source"},{"openapi":"openapi-butterfly.json get /api/v1/data_sources/{data_source_id}/summary","title":"Get a data source summary","href":"/api-reference/data-sources/get-a-data-source-summary"},{"openapi":"openapi-butterfly.json post /api/v1/data_sources/{data_source_id}/test","title":"Test a data source connection","href":"/api-reference/data-sources/test-a-data-source-connection"}]},{"group":"Data diffs","pages":[{"openapi":"openapi-butterfly.json get /api/v1/datadiffs","title":"List data diffs","href":"/api-reference/data-diffs/list-data-diffs"},{"openapi":"openapi-butterfly.json post /api/v1/datadiffs","title":"Create a data diff","href":"/api-reference/data-diffs/create-a-data-diff"},{"openapi":"openapi-butterfly.json get /api/v1/datadiffs/{datadiff_id}","title":"Get a data diff","href":"/api-reference/data-diffs/get-a-data-diff"},{"openapi":"openapi-butterfly.json patch /api/v1/datadiffs/{datadiff_id}","title":"Update a data diff","href":"/api-reference/data-diffs/update-a-data-diff"},{"openapi":"openapi-butterfly.json post /api/v1/datadiffs/{datadiff_id}/cancel","title":"Cancel a running data diff","href":"/api-reference/data-diffs/cancel-a-running-data-diff"},{"title":"Get a human-readable summary of a DataDiff comparison","deprecated":null,"version":null,"openapi":"/openapi-butterfly.json get /api/v1/datadiffs/{datadiff_id}/summary","href":"/api-reference/data-diffs/get-a-human-readable-summary-of-a-datadiff-comparison"},{"openapi":"openapi-butterfly.json get /api/v1/datadiffs/{datadiff_id}/summary_results","description":"Get the summary results of a specific data diff via the Datafold API.","title":"Get a data diff summary","href":"/api-reference/data-diffs/get-a-data-diff-summary"}]},{"group":"Monitors","pages":[{"openapi":"openapi-butterfly.json get /api/v1/monitors","title":"List monitors","href":"/api-reference/monitors/list-monitors"},{"openapi":"openapi-butterfly.json post /api/v1/monitors/create/diff","description":"Create a data diff monitor via the Datafold API.","title":"Create a data diff monitor","href":"/api-reference/monitors/create-a-data-diff-monitor"},{"title":"Get a monitor","deprecated":null,"version":null,"openapi":"/openapi-butterfly.json get /api/v1/monitors/{id}","href":"/api-reference/monitors/get-a-monitor"},{"openapi":"openapi-butterfly.json delete /api/v1/monitors/{id}","title":"Delete a monitor","href":"/api-reference/monitors/delete-a-monitor"},{"openapi":"openapi-butterfly.json post /api/v1/monitors/{id}/run","title":"Trigger a run","href":"/api-reference/monitors/trigger-a-run"},{"title":"List a monitor's runs","deprecated":null,"version":null,"openapi":"/openapi-butterfly.json get /api/v1/monitors/{id}/runs","href":"/api-reference/monitors/list-a-monitors-runs"},{"title":"Get a monitor run","deprecated":null,"version":null,"openapi":"/openapi-butterfly.json get /api/v1/monitors/{id}/runs/{run_id}","href":"/api-reference/monitors/get-a-monitor-run"},{"title":"Enable or disable a monitor","deprecated":null,"version":null,"openapi":"/openapi-butterfly.json put /api/v1/monitors/{id}/toggle","href":"/api-reference/monitors/enable-or-disable-a-monitor"},{"openapi":"openapi-butterfly.json patch /api/v1/monitors/{id}/update","title":"Update a monitor","href":"/api-reference/monitors/update-a-monitor"}]}]},{"tab":"Frequently Asked Questions","pages":[{"title":"Frequently Asked Questions","href":"/faq/overview"}]}]},{"version":"Classic version","pages":[{"title":"Classic version","href":"/classic/api-reference/monitors/list-monitors"}]}]},"basePath":"","title":"List monitors - Datafold","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-BIYvYBgk.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}