Skip to main content
GET
/
api
/
rankings
/
{rankingId}
Get Single Ranking
curl --request GET \
  --url https://api.cludo.com/api/rankings/{rankingId} \
  --header 'Authorization: Basic <encoded-value>'
{
  "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>"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://signe.cludo.com/llms.txt

Use this file to discover all available pages before exploring further.

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

​
rankingId
integer
required

Numeric id of an existing ranking rule set.

Response

Ranking details.

​
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.

​
rankingterms
object[]

Terms that activate this ranking configuration.

​
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.