List Banners by Engine

Returns all banners configured for the given search engine.

GET /api/banners/site/{engineId}

List Banners by Engine

cURL

curl --request GET \
  --url https://api.cludo.com/api/banners/site/{engineId} \
  --header 'Authorization: Basic <encoded-value>'

200

[
  {
    "name": "<string>",
    "htmlcode": "<string>",
    "websiteid": 123,
    "id": 123,
    "bannerterms": [
      {
        "name": "<string>"
      }
    ],
    "isDisabled": true,
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z",
    "audiences": [
      "<unknown>"
    ],
    "engineIds": [
      123
    ],
    "frequency": "<string>",
    "daysOfWeek": "<string>",
    "cssCode": "<string>",
    "jsonOption": "<string>",
    "editorType": "<string>",
    "brokenLinksFoundAt": "<string>"
  }
]

Authorizations

Authorization · string · header · required

Basic authentication. Use your Customer ID as the username and API Key as the password. Example header: Authorization: Basic MTIzNDU2NzpteS1hcGkta2V5.

Path Parameters

engineId · integer · required

Search engine whose banners, rankings, or quicklinks you are managing.

Response

200

application/json

List of banners for the engine.

name · string · required

Internal label in MyCludo (not shown to end users).

htmlcode · string · required

HTML snippet injected on the SERP when terms match (keep accessible and scoped).

websiteid · integer · required

Search engine ID.

id · integer

Banner ID (assigned by server on create).

bannerterms · object[]

List of trigger phrases; any match can activate the banner depending on engine rules.

Show child attributes

isDisabled · boolean

When true, the banner is stored but never served.

from · string<date-time> | null

Start of scheduled display window.

to · string<date-time> | null

End of scheduled display window.

audiences · any[] | null

Audience targeting configuration. Omit the field entirely (or send null) when the banner is not audience-targeted.

engineIds · integer[] | null

Managed by the Cludo backend; informational only.

frequency · string | null

Managed by the Cludo backend; informational only.

daysOfWeek · string | null

Managed by the Cludo backend; informational only.

cssCode · string | null

Managed by the Cludo backend; informational only.

jsonOption · string | null

Managed by the Cludo backend; informational only.

editorType · string | null

Managed by the Cludo backend; informational only.

brokenLinksFoundAt · string | null

Timestamp when broken links were last detected, if any.