Live Search History

GET 30 Credits / 30 days /android/keywords/kw-rankings.json

Giving the opposite result as Keywords Rankings for Applications, this endpoint will list applications that were ranked for a given keyword during the interval of time requested. The response will be computed in a best-effort basis, and the list might be incomplete or empty if there's no data available for the period requested.

Live Search History Request

This method returns the rankings for the provided keyword.

Header parameters
X-AppTweak-Key:
Your AppTweak API Key.
Query parameters
keyword: string Required

An url encoded string with the keyword you want to get the rankings for.

country: string us

The two letter country code (ISO Alpha-2) you want to fetch the app in.

Get the list of our country codes, here.

language: string en

The two letter language (ISO Alpha-2) you want to fetch the application in.

Get the list of our language codes, here.

start_date: date

The first date for which to get data in YYYY-MM-DD format. The default value is yesterday.

end_date: date

The last date for which to get data in YYYY-MM-DD format. The default value is 90 days ago.

limit: integer [0..500]

An upper limit of how many results should be returned per date.

GET /android/keywords/kw-rankings.json

Request example
GET /android/keywords/kw-rankings.json?country=us&language=us&keyword=mastodon&limit=10&start_date=2019-03-24&end_date=2019-03-31
cURL example
curl -X GET -H "X-Apptweak-Key: ${API_KEY}" https://api.apptweak.com/android/keywords/kw-rankings.json?country=us&language=us&keyword=mastodon&limit=10&start_date=2019-03-24&end_date=2019-03-31

Live Search History Response

The response is a JSON object. Each key of the object is a date within the required interval, the matching value is a ranking object holding an array of ranked applications.

Object properties
rankings: array

An array containing the id of the applications that ranked in the day of the current key in which the first application is the the highest ranked.

Response Example

{
  "content": {
    "2019-03-24": {
      "rankings": [
        "com.keylesspalace.tusky",
        "fr.gouv.etalab.mastodon",
        "club.tootdon.app",
        "com.mastopane",
        "jp.juggler.subwaytooter",
        "io.github.koss.mammut",
        "com.jeroensmeets.mastodon",
        "com.github.moko256.twitlatte",
        "com.gilawhost.stegolophodon",
        "com.keylesspalace.tusky.test"
      ]
    },
    "2019-03-25": {
      "rankings": [
        "com.keylesspalace.tusky",
        "fr.gouv.etalab.mastodon",
        "club.tootdon.app",
        "com.mastopane",
        "com.jeroensmeets.mastodon",
        "com.github.moko256.twitlatte",
        "com.gilawhost.stegolophodon",
        "jp.juggler.subwaytooter",
        "com.keylesspalace.tusky.test",
        "io.github.koss.mammut"
      ]
    },
    "2019-03-26": {
      "rankings": [
        "com.keylesspalace.tusky",
        "fr.gouv.etalab.mastodon",
        "club.tootdon.app",
        "io.github.koss.mammut",
        "com.keylesspalace.tusky.test",
        "com.mastopane",
        "com.jeroensmeets.mastodon",
        "com.github.moko256.twitlatte",
        "jp.juggler.subwaytooter",
        "com.gilawhost.stegolophodon"
      ]
    },
    "2019-03-27": {
      "rankings": [
        "com.keylesspalace.tusky",
        "fr.gouv.etalab.mastodon",
        "club.tootdon.app",
        "com.mastopane",
        "com.jeroensmeets.mastodon",
        "com.keylesspalace.tusky.test",
        "com.gilawhost.stegolophodon",
        "jp.juggler.subwaytooter",
        "com.github.moko256.twitlatte",
        "io.github.koss.mammut"
      ]
    },
    "2019-03-28": {
      "rankings": [
        "com.keylesspalace.tusky",
        "fr.gouv.etalab.mastodon",
        "club.tootdon.app",
        "io.github.koss.mammut",
        "com.mastopane",
        "com.keylesspalace.tusky.test",
        "jp.juggler.subwaytooter",
        "com.jeroensmeets.mastodon",
        "com.github.moko256.twitlatte",
        "com.gilawhost.stegolophodon"
      ]
    },
    "2019-03-29": {
      "rankings": [
        "com.keylesspalace.tusky",
        "club.tootdon.app",
        "fr.gouv.etalab.mastodon",
        "io.github.koss.mammut",
        "com.mastopane",
        "com.keylesspalace.tusky.test",
        "com.jeroensmeets.mastodon",
        "jp.juggler.subwaytooter",
        "com.github.moko256.twitlatte",
        "com.mastodonpartners"
      ]
    },
    "2019-03-30": {
      "rankings": [
        "com.keylesspalace.tusky",
        "club.tootdon.app",
        "fr.gouv.etalab.mastodon",
        "com.mastopane",
        "io.github.koss.mammut",
        "com.keylesspalace.tusky.test",
        "com.jeroensmeets.mastodon",
        "jp.juggler.subwaytooter",
        "net.knzkdev.app",
        "com.github.moko256.twitlatte"
      ]
    },
    "2019-03-31": {
      "rankings": [
        "com.keylesspalace.tusky",
        "club.tootdon.app",
        "fr.gouv.etalab.mastodon",
        "com.mastopane",
        "com.jeroensmeets.mastodon",
        "jp.juggler.subwaytooter",
        "com.keylesspalace.tusky.test",
        "io.github.koss.mammut",
        "com.github.moko256.twitlatte",
        "com.gilawhost.stegolophodon"
      ]
    }
  },
  "metadata": {
    "request": {
      "path": "/android/keywords/kw-rankings.json",
      "store": "android",
      "params": {
        "country": "us",
        "language": "us",
        "keyword": "mastodon",
        "limit": 10,
        "start_date": "2019-03-24T00:00:00+00:00",
        "end_date": "2019-03-31T00:00:00+00:00",
        "format": "json"
      },
      "performed_at": "2019-07-15 14:55:10 UTC"
    },
    "content": {
    }
  }
}