List Rankings by Engine

Returns all rankings configured for the given search engine.

GET /api/rankings/site/{engineId}

List Rankings by Engine

cURL

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

200

[
  {
    "name": "<string>",
    "WebsiteId": 123,
    "id": 123,
    "pages": [
      {
        "rank": 1,
        "showpage": true,
        "page": {
          "name": "<string>",
          "pageid": "<string>",
          "pageurl": "<string>",
          "searchable": true,
          "websiteid": 123
        },
        "websiteid": 123
      }
    ],
    "rankingterms": [
      {
        "name": "<string>"
      }
    ],
    "brokenLinksFoundAt": "<string>",
    "audiences": [
      "<unknown>"
    ]
  }
]

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 rankings for the engine.

name · string · required

Label for this ranking group in the dashboard.

WebsiteId · integer · required

Search engine ID.

id · integer

Ranking ID (assigned by server on create).

pages · object[]

URLs and weights for pinned or boosted results.

Show child attributes

rankingterms · object[]

Terms that activate this ranking configuration.

Show child attributes

brokenLinksFoundAt · string | null

Managed by the Cludo backend; informational only.

audiences · any[] | null

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