Personal Content API
The Personalization functionality was created to provide the right content to your app users.
Get Personal Content
GET https://contentapi.celltick.com/mediaApi/v1.0/personal/content
Method returns content based on user past reading preferences. API can also filter out already read articles by user (Partner settings level)
Query Parameters
vendorFilter
string
Filtered out comma separated list of content providers
vendor
string
comma separated list of content providers
team
string
comma separated team list of Wikipedia ids
person
string
comma separated person list of Wikipedia ids
topic
string
comma separated topic list names or Wikipedia ids. In case extended search is needed, add :ext to topic name. (e.g. weather:ext)
sortBy
string
Parameter used to allow content sort by "newest" articles first (in descending order). When using the 'sortBy' parameter it overrides the "personal" method. In case parameter not in use, content order define by System.
thumbImgQuality
integer
Set thumbnail image quality (e.g. 30 is 30% of the original quality)
thumbImgWidth
integer
Set thumbnail image width (pixels)
thumbImgHeight
integer
Set thumbnail image height (pixels)
offset
integer
For paging only. When offset=0 returns all query content items.
limit
integer
Limits the number of returned content items. Default is 20.
language
string
2 letter language code (ISO 639-1)
localCountryCode
string
Allows fetching categories by local country 2 letter country code (ISO-ALPHA-2)
originCountryCode
string
Allows fetching categories by origin country 2 letter country code (ISO-ALPHA-2)
countryCode
string
Allows fetching content by country. 2 letter country code (ISO-ALPHA-2)
tag
string
Allows fetching content by tag names (case insensitive) [one or more]
categoryFilter
string
Allow filter out content by category names [one or more] e.g. categoryFilter=Sports,News
category
string
Allows fetching content by specific category names [one ot more] e.g. category=Sports,News (Case insensitive)
publishedAfter
string
Allows fetching content from point in time and on. Date/time of publication format is: "MM/dd/yyyy hh:mm:ss"
optOut
string
Allowed values are: true/false
aid
string
Mandatory in case of android application
userId
string
Source user id (UUID)
How does the Personalization feature work?
When user opens the feed for the first time, Start Magazine will return content based on its general algorithm. After a user reads a few articles he will notice that more and more articles match his previous choices.
After a while, a user re-opening a feed will see the articles with content similar to previous clicks. The system allows to control the content mix of his feed, time based, and/or personal types of articles.
For example:
If the user reads more articles related to Sports, when reopening the feed after a certain time, he will see mostly sport articles.
How do I implement personalization using the API?
Build the feed page you want with the returned content.
For example:
Try to click some articles you like, once you do, Start Magazine will begin to save the article list you see in its cache.
After a few minutes, reopen the feed. You will see your favorite article types populating.
What else should I keep in mind before implementation?
The Personalization feature is only suitable for the C-S model. That means the client must communicate directly with the Start Magazine server.
The userId should be unique for each user. This is a critical requirement because the server will recognize each user according to his or her unique userId, and thereby return personalized article lists. The best format is UUID.
Last updated
