API Reference
Get search ranking
Returns how a brand ranks in delivery-app search over time for a term, as a daily timeline of median position per source, flagging where the placement was sponsored. Scope it to a neighbourhood, or a city plus neighbourhood, to read local visibility. For the default view (the ranking with no query typed), pass searchQueryType=default and omit searchQuery.
GET
/brands/{brandSlug}/search-rankingAuthorizationBearer <token>
In: header
Path Parameters
brandSlugstring
Query Parameters
countryCodestring
Value in
"ae" | "sa" | "kw" | "qa" | "bh" | "eg" | "jo" | "om" | "ma" | "kz" | "iq"searchQuery?string
The term to chart. Omit for the default view (searchQueryType=default).
city?string
neighbourhood?string
neighbourhoodId?string
source?string
searchQueryType?string
Narrow to one type. Use 'default' for the no-query default view.
Value in
"cuisine" | "dish" | "brand" | "default"searchMode?string
How the ranking was measured: 'free_text' (a typed search) or 'native' (the source's own category). Ignored for the default view.
Value in
"free_text" | "native"from?string
Format
dateto?string
Format
datelimit?integer
Range
1 <= valuecursor?string
Response Body
curl -X GET "https://loading/v1/brands/string/search-ranking?countryCode=ae&searchQuery=string&city=string&neighbourhood=string&neighbourhoodId=string&source=string&searchQueryType=cuisine&searchMode=free_text&from=2019-08-24&to=2019-08-24&limit=1&cursor=string"{
"data": [
{
"source": "string",
"date": "string",
"rank": 0,
"sponsored": true,
"city": "string",
"neighbourhood": "string",
"neighbourhoodId": "string"
}
],
"pageInfo": {
"nextCursor": "string",
"hasMore": true
}
}Empty
Empty
Empty
Empty
Empty