Application keyword rankings

Returns 30 days history of application rankings by keyword

GET /api/app-keyword-ranking

Query parameters

Mandatory

  • storetype - store type (appstore or googleplay)

  • storeid - store id of app (for example com.google.android.apps.maps or 585027354)

  • country - country ISO code (ex.: US, RU, GB etc.)

  • query - keyword to search for. Bulk mode is available - separate keywords by “,” symbol. Example - “query=taxi,uber”

Optional

  • timestamp (default: now) - timestamp of search results in ISO format (YYYY-MM-DDThh:mmTZD, ex.: 2017-07-16T19:20%2B03:00) Note that plus sign is replaced with %2B

Example request

GET /api/app-keyword-ranking?country=US&storetype=appstore&storeid=1077853625&query=airtickets

If we have all required information for this request, you will get following response:

Status: 200 OK

Single mode

{
    "id": <string>,  // request id for technical support purposes
    "data": {
        "timestamp": <string>,  // ISO format timestamp of results,
        "storetype": <string>,  // same as specified in query params,
        "storeid": <string>,  // same as specified in query params,
        "country": <string>,  // same as specified in query params,
        "query": <string>,  // same as specified in query params,
        "results": {
            "stats": {
                <string>: {  // date(ISO) YYYY-MM-DD, ex.: 2019-03-03
                    "rank": <integer>,  // rank (0 for application absence)
                }
            }
        }

    }
}

Bulk mode

{
    "id": <string>,  // request id for technical support purposes
    "data": {
        "timestamp": <string>,  // ISO format timestamp of results,
        "storetype": <string>,  // same as specified in query params,
        "storeid": <string>,  // same as specified in query params,
        "country": <string>,  // same as specified in query params,
        "query": <string>,  // same as specified in query params,
        "results": {
            "stats": {
                <string>: {  // keyword
                    <string>: {  // date(ISO) YYYY-MM-DD, ex.: 2019-03-03
                        "rank": <integer>,  // rank (0 for application absence)
                    }
                }
            }
        }
    }
}

If we need to download some additional data from store’s servers, you will get following response:

Status: 202 Accepted

{
    "key": <string>,  //request key for technical support purposes
    "detail": "Result is preparing, try in 30 seconds later"
}

So, try in 30 seconds later and if response will be ready you will get full data.

If store’s servers got no required data or we don’t have required data, you will get following response:

Status: 204 No Content

You may try later to get expected data.