Preview leaderboard rankings

POST

/runtime-leaderboards/preview-rankings

Runtime Leaderboards

Executes a draft leaderboard query specification and returns the ranked rows, without persisting anything. Used by create/edit flows to preview a configuration before saving it.

Request

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Preview computed successfully

Bodyapplication/json

🟠401Unauthorized

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.aworld.cloud/dashboard/v1/runtime-leaderboards/preview-rankings' \
--header 'Content-Type: application/json' \
--data '{
    "query": {
        "from": {
            "sources": [
                {
                    "table": "string",
                    "alias": "string",
                    "joins": [
                        {
                            "type": "INNER",
                            "toAlias": "string",
                            "condition": {
                                "==": [
                                    1,
                                    1
                                ]
                            }
                        }
                    ]
                }
            ],
            "where": {
                "==": [
                    1,
                    1
                ]
            }
        },
        "select": {
            "fields": [
                {
                    "source": "string",
                    "alias": "string"
                }
            ],
            "expressions": [
                {
                    "name": "string",
                    "expression": {
                        "==": [
                            1,
                            1
                        ]
                    }
                }
            ]
        },
        "with": [
            {
                "name": "string",
                "query": {
                    "from": {
                        "sources": [
                            {
                                "table": "string",
                                "alias": "string"
                            }
                        ],
                        "where": {
                            "==": [
                                1,
                                1
                            ]
                        }
                    },
                    "select": {
                        "fields": [
                            {
                                "source": "string",
                                "alias": "string"
                            }
                        ],
                        "expressions": [
                            {
                                "name": "string",
                                "expression": {
                                    "==": [
                                        1,
                                        1
                                    ]
                                }
                            }
                        ]
                    },
                    "groupBy": {
                        "columns": [
                            "string"
                        ]
                    },
                    "having": {
                        "==": [
                            1,
                            1
                        ]
                    },
                    "orderBy": {
                        "expressions": [
                            {
                                "expression": {
                                    "==": [
                                        1,
                                        1
                                    ]
                                },
                                "direction": "ASC"
                            }
                        ],
                        "window": {
                            "function": "ROW_NUMBER",
                            "alias": "string"
                        },
                        "tieExpressions": [
                            {
                                "expression": {
                                    "==": [
                                        1,
                                        1
                                    ]
                                },
                                "direction": "ASC"
                            }
                        ]
                    }
                },
                "recursive": {
                    "table": "string",
                    "keyColumn": "string",
                    "parentColumn": "string",
                    "startFrom": {
                        "==": [
                            1,
                            1
                        ]
                    },
                    "maxDepth": 1
                },
                "join": {
                    "type": "INNER",
                    "on": {
                        "==": [
                            1,
                            1
                        ]
                    }
                }
            }
        ],
        "groupBy": {
            "columns": [
                "string"
            ]
        },
        "having": {
            "==": [
                1,
                1
            ]
        },
        "orderBy": {
            "expressions": [
                {
                    "expression": {
                        "==": [
                            1,
                            1
                        ]
                    },
                    "direction": "ASC"
                }
            ],
            "window": {
                "function": "ROW_NUMBER",
                "alias": "string"
            },
            "tieExpressions": [
                {
                    "expression": {
                        "==": [
                            1,
                            1
                        ]
                    },
                    "direction": "ASC"
                }
            ]
        },
        "search": [
            {
                "in": "title",
                "as": "inTitle",
                "for": {
                    "==": [
                        1,
                        1
                    ]
                }
            }
        ]
    },
    "timeframeStartsAt": "2019-08-24T14:15:22.123Z",
    "timeframeEndsAt": "2019-08-24T14:15:22.123Z",
    "sampleAudienceVars": {
        "property1": "string",
        "property2": "string"
    },
    "limit": 50
}'

Response Example

{
    "items": [
        {
            "rank": 1,
            "entityId": "string",
            "entityType": "string",
            "primaryEntityName": "string",
            "secondaryEntityName": "string",
            "entityImageUrl": "http://example.com",
            "score": 0
        }
    ],
    "totalCount": 0
}

Modified at 2026-09-10 08:52:01

Archive runtime leaderboard

Get leaderboard rankings