Engagd ItemRank

ItemRank provides ranking for web pages and feeds based on a user's attention profile. Learn more about the purpose of ItemRank on the Engagd website.

Basics

• API access requires a developers key, available via the developers.engagd.com site.
• User accounts will be created implicitly.
• The user ids provided to the API need not be numeric or follow any special pattern - they can be anything meaningful to the calling application
• To recieve ranks for each item in a given feed, retrieve a ranked feed url. The provided url can be accessed periodically, and will be augmented with a <rank> tag for each item.

REST API

The REST (Representational State Transfer) API allows manipulation of the user's profile via resources exposed through HTTP addresses.

Basics

• Resources are manipulated through the HTTP methods GET, POST, PUT and DELETE.
• Provided page and feed urls should be url-encoded.

Ranking

Ranking a Page

This will return an ItemRank value for the 'Personal Relevance' of a given page based on the user's APML and other factors

GET: https://itemrank.engagd.com/user/<devKey>/<userId>/rank/page?url=<pageUrl>

Retrieving a Ranked Feed URLThis will return an ItemRank value for the 'Personal Relevance' of a items in a feed based on the user's APML and other factors. The ItemRank value is included as an additional 'Rank' tag in an otherwise standard RSS or Atom feed.

GET: https://itemrank.engagd.com/user/<devKey>/<userId>/rank/feed?url=<feedUrl>

Filtering

Filtering a Feed based on ItemRank

The ranked feed urls provided by ItemRank can also be filtered to only include items with a given minimum rank. Append "?minRank=x" where x represents a floating point number between -1 and 1 to retrieve only items with ranks higher than the given value.

Retrieving/Uploading APML

To retreive or upload a user APML file refer to the APML API.

Service Updates

Keep track of changes to this service and the API via the ItemRank API Change Log.