Skip to main content
POST
/
api
/
rankings
Create Ranking
curl --request POST \
  --url https://api.cludo.com/api/rankings \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "WebsiteId": 123,
  "pages": [
    {
      "rank": 1,
      "showpage": true,
      "page": {
        "name": "<string>",
        "pageid": "<string>",
        "pageurl": "<string>",
        "searchable": true,
        "websiteid": 123
      },
      "websiteid": 123
    }
  ],
  "rankingterms": [
    {
      "name": "<string>"
    }
  ],
  "audiences": [
    "<unknown>"
  ]
}
'
{
  "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://cludo.mintlify.app/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.

Body

application/json

Ranking payload without id (server assigns id).

name
string
required

Display name for the new ranking set.

WebsiteId
integer
required

Search engine ID this ranking belongs to.

pages
object[]

Pages to pin or hide, with their rank position.

rankingterms
object[]

Search terms that activate this ranking when matched.

audiences
any[] | null

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

Response

Ranking created successfully.

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.

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.