Toptimize

[Beta] Rank objects

⚠️ Beta Access Required

Contact your sales representative to gain access to this endpoint and start using it.

Use the /ranking endpoint to re-rank objects to show on a page. This endpoint can retrieve sponsored and non-sonsored objects and rank them together, according to an appropriate context and behavior information.

post/toptimize/v1/rank

Request

Base URL: https://api.topsort.com
URL: https://api.topsort.com/toptimize/v1/rank
Auth: HTTP bearer

Request body

Example request

{
  "ranking": [
    {
      "type": "listings",
      "slots": 3,
      "pageSize": 3,
      "page": {
        "type": "category",
        "value": "sneakers",
        "pageId": "/category/sneakers"
      },
      "opaqueUserId": "u_9ske45"
    }
  ]
}

Response

The ranking results. The list of winners will contain at most slots entries per auction. It may contain fewer or no entries at all if there aren't enough products to fill the slots.

Example response

{
  "results": [
    {
      "resultType": "listings",
      "results": [],
      "error": false
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.