Filtered Featured Stories allows you to fetch all the stories featured in Today tab that AppTweak has been able to gather about a specific app on the App Store in the selected countries on a given period.
Please note that the example has been stripped of redundant data to keep the documentation as concise as possible. The API might return additional, undocumented fields in the JSON, which your App should not rely upon.
The Filtered Stories list contains a series of story entries describing the position of this latter along with the related apps ids appearing within the story. Those results are listed per date and country.
A string of concatenated two-letter country code (ISO Alpha-2) separated per comma.
Get the list of our country codes, here.
Start date, format: YYYY-MM-DD
End date, format: YYYY-MM-DD
Application Id for which we try to found related featured content.
GET /ios/stories/filter.json?countries=us,be&start_date=2019-07-01&end_date=2019-07-15
curl -X GET -H "X-Apptweak-Key: ${API_KEY}" "https://api.apptweak.com/ios/stories/filter.json?countries=us,be&start_date=2019-07-01&end_date=2019-07-15"The response to the filtered stories request is a JSON hash containing a list of stories ids with their related position and applications ids, per date and country
The ID that Apple has given to the story.
Position of this story within the Today section (order of appearance)
Array of numbers container the related applications ids.
{
"content": {
"2019-07-01": {
"be": {
"1450572364": {
"position": 2,
"app_ids": [
1237463989
]
},
"1458704318": {
"position": 3,
"app_ids": [
1438513473
]
},
"1463233973": {
"position": 4,
"app_ids": [
1296747770,
543186831,
1089225191,
1241887528,
1437397276,
1151811380
]
}
},
"us": {
"1441056353": {
"position": 3,
"app_ids": [
1358476597
]
},
"1463651760": {
"position": 4,
"app_ids": [
1440066037
]
}
}
},
"2019-07-02": {
"be": {
"1273968298": {
"position": 3,
"app_ids": [
1194489616
]
},
"1446364601": {
"position": 2,
"app_ids": [
1425915725
]
},
"1466744248": {
"position": 1,
"app_ids": [
1053012308
]
}
},
"us": {
"1460838113": {
"position": 2,
"app_ids": [
1227830356
]
},
"1463634873": {
"position": 3,
"app_ids": [
1456333098
]
},
"1463653183": {
"position": 4,
"app_ids": [
1436303395
]
}
}
}
},
"metadata": {
"request": {
"path": "/stories/filter.json",
"store": "ios",
"params": {
"start_date": "2019-07-01T00:00:00+00:00",
"end_date": "2019-07-15T00:00:00+00:00",
"countries": "be,us",
"format": "json"
},
"performed_at": "2019-07-30 13:59:07 UTC"
},
"content": {
}
}
}