Timestamp when broken links were last detected, if any.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Cludo API Documentation","colors":{"primary":"#5B4EFF","light":"#8B7FFF","dark":"#3D2ECC"},"logo":{"light":"https://mintcdn.com/cludo/VlW3XL1sCSBiIopK/images/cropped-cropped-Cludo_New_2021_Black-1.png?fit=max\u0026auto=format\u0026n=VlW3XL1sCSBiIopK\u0026q=85\u0026s=1da2012a65174d0e8987bbb2a3428a1f","dark":"https://mintcdn.com/cludo/QSqg9vB71E-uhtLM/images/Cludo_New_2021_White-01.png?fit=max\u0026auto=format\u0026n=QSqg9vB71E-uhtLM\u0026q=85\u0026s=96205b256cd0af679f7ed7cd6a7a9445"},"favicon":"https://mintcdn.com/cludo/PNai9WMfBGw4gQ9V/images/Cludo_Site_Icon.png?fit=max\u0026auto=format\u0026n=PNai9WMfBGw4gQ9V\u0026q=85\u0026s=2658cbf2e4ea92bc14f7210485c60b4c","api":{"playground":{"display":"interactive"},"examples":{"languages":["bash","python","javascript","typescript"],"prefill":true},"mdx":{"server":["https://api.cludo.com","https://api-us1.cludo.com"]}},"background":{"decoration":"gradient","color":{"light":"#f2f4f7"}},"navbar":{"links":[{"href":"https://cludo.com/resources/contact-support/","label":"Support"}],"primary":{"type":"button","label":"MyCludo","href":"https://my.cludo.com"}},"footer":{"links":[{"header":"Resources","items":[{"label":"Support","href":"https://cludo.com/resources/contact-support"},{"label":"Status","href":"https://status.cludo.com"}]}]},"search":{},"fonts":{"family":"Poppins"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cludo","hasAudioNarration":false,"actualSubdomain":"cludo","customDomains":["docs.cludo.com"],"gitSource":{"type":"github","owner":"cludo","repo":"cludo-api-documentation-2026","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad7582aee7653c65618e8c1","collectionId":"ee5697fb-ff48-4ada-9c32-bcbb28abed93","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad7582aee7653c65618e8c1"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ad7582aee7653c65618e8c1","clientVersion":"0.0.4074","searchFilterCounts":[{"language":"default","tag":"API Reference","count":39},{"language":"default","tag":"Search Tools","count":22},{"language":"default","tag":"Overview","count":16},{"language":"default","tag":"Quicklinks","count":7},{"language":"default","tag":"AI","count":6},{"language":"default","tag":"Guides","count":5},{"language":"default","tag":"Content \u0026 Indexing","count":5},{"language":"default","tag":"Banners","count":5},{"language":"default","tag":"Page Rankings","count":5},{"language":"default","tag":"Get Started","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@cludo.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"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":"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":"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":"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},{"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":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"styles/custom.css","content":"body{color:#000000}"}],"page":{"pagePath":"api-reference/list-banners-by-engine","slug":"/api-reference/list-banners-by-engine","pageMetadata":{"title":"List Banners by Engine","description":"Returns all banners configured for the given search engine.","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/banners/site/{engineId}","href":"/api-reference/list-banners-by-engine","autogeneratedByOpenApi":true},"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: \"Returns all banners configured for the given search engine.\"\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":{"title":"List Banners by Engine","description":"Returns all banners configured for the given search engine.","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/banners/site/{engineId}","href":"/api-reference/list-banners-by-engine","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"listBanners","summary":"List Banners by Engine","description":"Returns all banners configured for the given search engine.","security":["b88a7c5f-f207-4f7c-9e02-b842e88df99b"],"parameters":["b530f6fa-4e8a-45d4-9874-79f238403935"],"responses":{"200":"b44106e5-6f24-43d5-a687-36673c386018","401":"060dfed1-114b-4936-a100-c5e317daff33","500":"acdac229-3f2c-4472-a905-0f3334fdbb0b"},"method":"get","type":"path","servers":["36469293-ed74-4096-809f-c6babb9f39b2","a857e590-e1bd-4f3b-a35d-f4aa3f5dc51f"],"path":"/api/banners/site/{engineId}","baseUrlOptions":["https://api.cludo.com","https://api-us1.cludo.com"],"title":"List Banners by Engine","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","typescript"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[]},"dependencies":{"parameters":{"b530f6fa-4e8a-45d4-9874-79f238403935":{"name":"engineId","in":"path","required":true,"description":"Search engine whose banners, rankings, or quicklinks you are managing.","schema":{"type":"integer","isRequired":true,"description":"Search engine whose banners, rankings, or quicklinks you are managing.","uniqueKey":"","typeLabel":"integer"}}},"responses":{"b44106e5-6f24-43d5-a687-36673c386018":{"description":"List of banners for the engine.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["name","htmlcode","websiteid"],"properties":{"name":{"type":"string","description":"Internal label in MyCludo (not shown to end users).","isRequired":true,"uniqueKey":"items.[INDEX].name","typeLabel":"string"},"htmlcode":{"type":"string","description":"HTML snippet injected on the SERP when terms match (keep accessible and scoped).","isRequired":true,"uniqueKey":"items.[INDEX].htmlcode","typeLabel":"string"},"websiteid":{"type":"integer","description":"Search engine ID.","isRequired":true,"uniqueKey":"items.[INDEX].websiteid","typeLabel":"integer"},"id":{"type":"integer","description":"Banner ID (assigned by server on create).","uniqueKey":"items.[INDEX].id","typeLabel":"integer"},"bannerterms":{"type":"array","items":{"type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string","description":"Search term or phrase that triggers this banner when the user’s query matches.","isRequired":true,"uniqueKey":"items.[INDEX].bannerterms.items.[INDEX].name","typeLabel":"string"}},"uniqueKey":"items.[INDEX].bannerterms.items.[INDEX]","typeLabel":"object"},"description":"List of trigger phrases; any match can activate the banner depending on engine rules.","uniqueKey":"items.[INDEX].bannerterms","typeLabel":"object[]"},"isDisabled":{"type":"boolean","description":"When true, the banner is stored but never served.","uniqueKey":"items.[INDEX].isDisabled","typeLabel":"boolean"},"from":{"oneOf":[{"type":"string","format":"date-time","description":"Start of scheduled display window.","uniqueKey":"items.[INDEX].from.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Start of scheduled display window.","uniqueKey":"items.[INDEX].from.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].from","typeLabel":"string\u003cdate-time> | null"},"to":{"oneOf":[{"type":"string","format":"date-time","description":"End of scheduled display window.","uniqueKey":"items.[INDEX].to.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"End of scheduled display window.","uniqueKey":"items.[INDEX].to.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].to","typeLabel":"string\u003cdate-time> | null"},"audiences":{"oneOf":[{"type":"array","items":{"oneOf":[{}],"uniqueKey":"items.[INDEX].audiences.oneOf.0.items.[INDEX]","typeLabel":"any"},"description":"Audience targeting configuration. Omit the field entirely (or send `null`) when the banner is not audience-targeted.","uniqueKey":"items.[INDEX].audiences.oneOf.0","typeLabel":"any[]"},{"type":"null","items":{"oneOf":[{}]},"description":"Audience targeting configuration. Omit the field entirely (or send `null`) when the banner is not audience-targeted.","uniqueKey":"items.[INDEX].audiences.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].audiences","typeLabel":"any[] | null"},"engineIds":{"oneOf":[{"type":"array","items":{"type":"integer","uniqueKey":"items.[INDEX].engineIds.oneOf.0.items.[INDEX]","typeLabel":"integer"},"description":"Managed by the Cludo backend; informational only.","uniqueKey":"items.[INDEX].engineIds.oneOf.0","typeLabel":"integer[]"},{"type":"null","items":{"type":"integer"},"description":"Managed by the Cludo backend; informational only.","uniqueKey":"items.[INDEX].engineIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].engineIds","typeLabel":"integer[] | null"},"frequency":{"oneOf":[{"type":"string","description":"Managed by the Cludo backend; informational only.","uniqueKey":"items.[INDEX].frequency.oneOf.0","typeLabel":"string"},{"type":"null","description":"Managed by the Cludo backend; informational only.","uniqueKey":"items.[INDEX].frequency.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].frequency","typeLabel":"string | null"},"daysOfWeek":{"oneOf":[{"type":"string","description":"Managed by the Cludo backend; informational only.","uniqueKey":"items.[INDEX].daysOfWeek.oneOf.0","typeLabel":"string"},{"type":"null","description":"Managed by the Cludo backend; informational only.","uniqueKey":"items.[INDEX].daysOfWeek.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].daysOfWeek","typeLabel":"string | null"},"cssCode":{"oneOf":[{"type":"string","description":"Managed by the Cludo backend; informational only.","uniqueKey":"items.[INDEX].cssCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Managed by the Cludo backend; informational only.","uniqueKey":"items.[INDEX].cssCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].cssCode","typeLabel":"string | null"},"jsonOption":{"oneOf":[{"type":"string","description":"Managed by the Cludo backend; informational only.","uniqueKey":"items.[INDEX].jsonOption.oneOf.0","typeLabel":"string"},{"type":"null","description":"Managed by the Cludo backend; informational only.","uniqueKey":"items.[INDEX].jsonOption.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].jsonOption","typeLabel":"string | null"},"editorType":{"oneOf":[{"type":"string","description":"Managed by the Cludo backend; informational only.","uniqueKey":"items.[INDEX].editorType.oneOf.0","typeLabel":"string"},{"type":"null","description":"Managed by the Cludo backend; informational only.","uniqueKey":"items.[INDEX].editorType.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].editorType","typeLabel":"string | null"},"brokenLinksFoundAt":{"oneOf":[{"type":"string","description":"Timestamp when broken links were last detected, if any.","uniqueKey":"items.[INDEX].brokenLinksFoundAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"Timestamp when broken links were last detected, if any.","uniqueKey":"items.[INDEX].brokenLinksFoundAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].brokenLinksFoundAt","typeLabel":"string | null"}},"uniqueKey":"items.[INDEX]","typeLabel":"object"},"uniqueKey":"","typeLabel":"object[]"},"examples":{"Example":{"title":"Example","value":[{"name":"\u003cstring>","htmlcode":"\u003cstring>","websiteid":123,"id":123,"bannerterms":[{"name":"\u003cstring>"}],"isDisabled":true,"from":"2023-11-07T05:31:56Z","to":"2023-11-07T05:31:56Z","audiences":["\u003cunknown>"],"engineIds":[123],"frequency":"\u003cstring>","daysOfWeek":"\u003cstring>","cssCode":"\u003cstring>","jsonOption":"\u003cstring>","editorType":"\u003cstring>","brokenLinksFoundAt":"\u003cstring>"}]}},"exampleType":"generated"}},"exampleType":"generated"},"060dfed1-114b-4936-a100-c5e317daff33":{"description":"Authentication failed. The Authorization header is missing or contains invalid credentials.","content":{"application/json":{"schema":{"type":"object","description":"Returned when authentication fails.","properties":{"message":{"type":"string","description":"Authentication failure reason.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"unauthorized"},"examples":{"Example":{"title":"Example","value":{"message":"unauthorized"}}},"exampleType":"examples"}},"exampleType":"examples"},"acdac229-3f2c-4472-a905-0f3334fdbb0b":{"description":"An unexpected server error occurred. If this persists, contact support@cludo.com.","content":{"application/json":{"schema":{"type":"object","description":"Returned when an unexpected server error occurs.","properties":{"status":{"type":"string","description":"HTTP status name.","uniqueKey":"status","typeLabel":"string"},"code":{"type":"integer","description":"HTTP status code.","uniqueKey":"code","typeLabel":"integer"},"messages":{"type":"array","items":{"type":"string","uniqueKey":"messages.items.[INDEX]","typeLabel":"string"},"description":"Error details, usually including a support reference id.","uniqueKey":"messages","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"status":"InternalServerError","code":500,"messages":["Error occur. Please contact support with error ID: a1b2c3d4-e5f6-7890-abcd-ef1234567890"]},"examples":{"Example":{"title":"Example","value":{"status":"InternalServerError","code":500,"messages":["Error occur. Please contact support with error ID: a1b2c3d4-e5f6-7890-abcd-ef1234567890"]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"b88a7c5f-f207-4f7c-9e02-b842e88df99b":{"BasicAuth":{"type":"http","scheme":"basic","description":"Basic authentication. Use your Customer ID as the username and API Key as the password. Example header: `Authorization: Basic MTIzNDU2NzpteS1hcGkta2V5`.","scopes":[]}}},"servers":{"36469293-ed74-4096-809f-c6babb9f39b2":{"url":"https://api.cludo.com","description":"EU region (Customer IDs below 10,000,000)"},"a857e590-e1bd-4f3b-a35d-f4aa3f5dc51f":{"url":"https://api-us1.cludo.com","description":"US region (Customer IDs 10,000,000 and above)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","description":"Basic authentication. Use your Customer ID as the username and API Key as the password. Example header: `Authorization: Basic MTIzNDU2NzpteS1hcGkta2V5`.","scopes":[]},"schema":{"title":"Basic Auth","type":"object","description":"Basic authentication. Use your Customer ID as the username and API Key as the password. Example header: `Authorization: Basic MTIzNDU2NzpteS1hcGkta2V5`.","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"BasicAuth","name":"Authorization"}],"title":"BasicAuth"}]},"originalFileLocation":"openapi/search-tools.json"},"subdomain":"cludo","siteName":"Cludo API Documentation","title":"List Banners by Engine - Cludo API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-13T15:05:13.868Z","originalFileLocation":"api-reference/list-banners-by-engine.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=\"Returns all banners configured for the given search engine.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Cludo API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cludo/jZhCi8DvpmlrCS0Y/_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/cludo/jZhCi8DvpmlrCS0Y/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cludo/jZhCi8DvpmlrCS0Y/_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/cludo/jZhCi8DvpmlrCS0Y/_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/cludo/jZhCi8DvpmlrCS0Y/_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/cludo/jZhCi8DvpmlrCS0Y/_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/cludo/jZhCi8DvpmlrCS0Y/_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/cludo/jZhCi8DvpmlrCS0Y/_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/cludo/jZhCi8DvpmlrCS0Y/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List Banners by Engine - Cludo API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns all banners configured for the given search engine.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Cludo API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.cludo.com/api-reference/list-banners-by-engine\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cludo.mintlify.site/_mintlify/api/og/v2?division=Banners\u0026amp;title=List+Banners+by+Engine\u0026amp;description=Returns+all+banners+configured+for+the+given+search+engine.\u0026amp;theme=f4d788710e8d0750e07f0271\u0026amp;signature=87d70ada48dde6aa17c9ebf0a7c8157a8f7cbae1ced82a50fe101e8dd2190eee\">\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 Banners by Engine - Cludo API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns all banners configured for the given search engine.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cludo.mintlify.site/_mintlify/api/og/v2?division=Banners\u0026amp;title=List+Banners+by+Engine\u0026amp;description=Returns+all+banners+configured+for+the+given+search+engine.\u0026amp;theme=f4d788710e8d0750e07f0271\u0026amp;signature=87d70ada48dde6aa17c9ebf0a7c8157a8f7cbae1ced82a50fe101e8dd2190eee\">\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/cludo/jZhCi8DvpmlrCS0Y/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Cludo API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5B4EFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.cludo.com/api-reference/list-banners-by-engine\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/list-banners-by-engine.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.cludo.com/#organization\",\"name\":\"Cludo API Documentation\",\"url\":\"https://docs.cludo.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cludo/VlW3XL1sCSBiIopK/images/cropped-cropped-Cludo_New_2021_Black-1.png?fit=max\u0026auto=format\u0026n=VlW3XL1sCSBiIopK\u0026q=85\u0026s=1da2012a65174d0e8987bbb2a3428a1f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.cludo.com#website\",\"name\":\"Cludo API Documentation\",\"url\":\"https://docs.cludo.com\",\"publisher\":{\"@id\":\"https://docs.cludo.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.cludo.com/api-reference/list-banners-by-engine#webpage\",\"url\":\"https://docs.cludo.com/api-reference/list-banners-by-engine\",\"name\":\"List Banners by Engine\",\"description\":\"Returns all banners configured for the given search engine.\",\"dateModified\":\"2026-05-13T15:05:13.868Z\",\"isPartOf\":{\"@id\":\"https://docs.cludo.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.cludo.com/api-reference/list-banners-by-engine#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.cludo.com/api-reference/list-banners-by-engine#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Search Tools\",\"item\":\"https://docs.cludo.com/api-reference/v4/search-tools/pre-search-suggestions\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Banners\",\"item\":\"https://docs.cludo.com/api-reference/create-banner\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"List Banners by Engine\",\"item\":\"https://docs.cludo.com/api-reference/list-banners-by-engine\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.cludo.com/api-reference/list-banners-by-engine#apireference\",\"headline\":\"List Banners by Engine\",\"name\":\"List Banners by Engine\",\"description\":\"Returns all banners configured for the given search engine.\",\"url\":\"https://docs.cludo.com/api-reference/list-banners-by-engine\",\"mainEntityOfPage\":{\"@id\":\"https://docs.cludo.com/api-reference/list-banners-by-engine#webpage\"},\"dateModified\":\"2026-05-13T15:05:13.868Z\",\"publisher\":{\"@id\":\"https://docs.cludo.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.cludo.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Cludo API Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Cludo API Documentation","nav":{"global":null,"tabs":[{"tab":"Overview","pages":[{"title":"Overview","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Reference Overview","href":"/api-reference/overview"}]},{"group":"Search","pages":[{"title":"Search","openapi":"POST /api/v4/{customerId}/{engineId}/search","href":"/api-reference/v4/search/search"},{"title":"Autocomplete","openapi":"GET /api/v4/{customerId}/{engineId}/autocomplete","href":"/api-reference/v4/search/autocomplete"}]},{"group":"AI","pages":[{"title":"AI Search Overview","href":"/api-reference/v4/ai/overview"},{"group":"AI Chat","pages":[{"title":"AI Chat","openapi":"POST /api/v4/{customerId}/{engineId}/search/answer","href":"/api-reference/v4/ai/chat"},{"title":"AI Chat Feedback","deprecated":null,"version":null,"openapi":"/openapi/ai.json post /api/v4/{customerId}/{engineId}/search/answer/feedback","href":"/api-reference/ai-chat-feedback"},{"title":"AI Chat Click","deprecated":null,"version":null,"openapi":"/openapi/ai.json post /api/v4/{customerId}/{engineId}/search/answer/click","href":"/api-reference/ai-chat-click"}]},{"group":"AI Summary","pages":[{"title":"AI Summary","openapi":"POST /api/v4/{customerId}/{engineId}/search/summarize","href":"/api-reference/v4/ai/summary"},{"title":"AI Summary Feedback","deprecated":null,"version":null,"openapi":"/openapi/ai.json post /api/v4/{customerId}/{engineId}/search/summarize/feedback","href":"/api-reference/ai-summary-feedback"}]}]},{"group":"Content \u0026 Indexing","pages":[{"group":"Documents","pages":[{"title":"Create or Replace","deprecated":null,"version":null,"openapi":"/openapi/index-management.json put /api/v4/{customerId}/index/{crawlerId}/documents","href":"/api-reference/create-or-replace"},{"title":"Partial Update","deprecated":null,"version":null,"openapi":"/openapi/index-management.json patch /api/v4/{customerId}/index/{crawlerId}/documents","href":"/api-reference/partial-update"},{"title":"Single Delete","deprecated":null,"version":null,"openapi":"/openapi/index-management.json delete /api/v4/{customerId}/index/{crawlerId}/documents","href":"/api-reference/single-delete"},{"title":"Bulk Delete","deprecated":null,"version":null,"openapi":"/openapi/index-management.json post /api/v4/{customerId}/index/{crawlerId}/documents/bulk-delete","href":"/api-reference/bulk-delete"}]},{"group":"Crawlers","pages":[{"title":"Queue URLs","deprecated":null,"version":null,"openapi":"/openapi/index-management.json post /api/v4/{customerId}/crawler/{crawlerId}/paths","href":"/api-reference/queue-urls"}]}]},{"group":"Tracking","pages":[{"title":"Track Search Query","deprecated":null,"version":null,"openapi":"/openapi/tracking.json post /api/v3/{customerId}/{engineId}/search/pushstat/querylog","href":"/api-reference/track-search-query"},{"title":"Track Result Click","deprecated":null,"version":null,"openapi":"/openapi/tracking.json post /api/v3/{customerId}/{engineId}/search/pushstat/clicklog","href":"/api-reference/track-result-click"}]},{"group":"Feedback","pages":[{"title":"Submit Feedback","deprecated":null,"version":null,"openapi":"/openapi/feedback.json post /api/v4/{customerId}/{engineId}/feedback","href":"/api-reference/submit-feedback"}]},{"group":"Search Tools","pages":[{"title":"Pre-search Suggestions","href":"/api-reference/v4/search-tools/pre-search-suggestions"},{"group":"Banners","pages":[{"title":"Create Banner","description":"Creates a banner. The server assigns `id`.","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json post /api/banners","href":"/api-reference/create-banner"},{"title":"List Banners by Engine","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/banners/site/{engineId}","href":"/api-reference/list-banners-by-engine"},{"title":"Get Single Banner","description":"Returns one banner by ID.","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/banners/{bannerId}","href":"/api-reference/get-single-banner"},{"title":"Update Banner","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json put /api/banners/{bannerId}","href":"/api-reference/update-banner"},{"title":"Delete Banner","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json delete /api/banners/{bannerId}","href":"/api-reference/delete-banner"}]},{"group":"Page Rankings","pages":[{"title":"Create Ranking","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json post /api/rankings","href":"/api-reference/create-ranking"},{"title":"List Rankings by Engine","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/rankings/site/{engineId}","href":"/api-reference/list-rankings-by-engine"},{"title":"Get Single Ranking","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/rankings/{rankingId}","href":"/api-reference/get-single-ranking"},{"title":"Update Ranking","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json put /api/rankings/{rankingId}","href":"/api-reference/update-ranking"},{"title":"Delete Ranking","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json delete /api/rankings/{rankingId}","href":"/api-reference/delete-ranking"}]},{"group":"Quicklinks","pages":[{"title":"Quicklinks","href":"/api-reference/v4/search-tools/quicklinks"},{"title":"Create Quicklink","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json post /api/quicklinks","href":"/api-reference/create-quicklink"},{"title":"List Quicklinks","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/engine/{engineId}/quicklinks","href":"/api-reference/list-quicklinks"},{"title":"Get Quicklink","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/quicklinks/{quicklinkId}","href":"/api-reference/get-quicklink"},{"title":"Get Quicklinks by Terms","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/engine/{engineId}/quicklinkterms","href":"/api-reference/get-quicklinks-by-terms"},{"title":"Update Quicklink","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json put /api/quicklinks/{quicklinkId}","href":"/api-reference/update-quicklink"},{"title":"Delete Quicklink","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json delete /api/quicklinks/{quicklinkId}","href":"/api-reference/delete-quicklink"}]},{"group":"Synonyms","pages":[{"title":"Create Synonym Group","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json post /api/synonymsgroup","href":"/api-reference/create-synonym-group"},{"title":"Get Synonyms by Language or Synonym Group","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/synonymsgroup/{identifier}","href":"/api-reference/get-synonyms-by-language-or-synonym-group"},{"title":"Update Synonym Group","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json put /api/synonymsgroup","href":"/api-reference/update-synonym-group"},{"title":"Delete Synonym Group","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json delete /api/synonymsgroup","href":"/api-reference/delete-synonym-group"}]}]}]}]},"basePath":"","title":"List Banners by Engine - Cludo API Documentation","buildId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","deploymentId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Myd8dsju.js","utils-C2HkQgW0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-8rSppmTv.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B6MjiCFm.js","snippetPresets-DwrSAONL.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-1-a5UQKQ.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C541m7wZ.js","shallow-CWELCZ77.js","getApiPlaygroundDisplay-CTo5Zn03.js","CodeSnippet-D--dzvnl.js","CodeSnippets-DM3cXEDh.js","Page-CxAy5y67.js","getPastedJson-C-VECgcL.js","icon-BPq2-Mg3.js","MethodPill-D9J5cUHd.js","DuplicateIcon-BqHaxUnD.js","createIcon-CIbcZHp9.js","DynamicMarkdown-BKiHAm_d.js","SectionHeading-DstQXt3H.js","axios-vUo_bRtp.js","Markdown-CpxgzsKA.js","clsx-C5EfhVm0.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CJ9Oly2E.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Mk6P3qvh.js"]}