Community articleMetrics Read Event Tracker API
Added by IBM contributorIBM | Edited by IBM contributordeveloperWorks Lotus Team on June 27, 2014
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

The Metrics Read Event Tracker API enables components or third party applications to post read events to the Metrics application. Metrics can track those read events and provide that information in reports.
Metrics Read Event Tracker API


The Metrics Read Event Tracker is a servlet resident inside the Metrics application. Applications that want to track the read event must make an HTTP POST request to this servlet and pass the necessary information. This servlet always returns a success response code.

Usage of the API:

URL: http://servername:port/metrics/service/eventTracker

HTTP POST Parameters:

  • source (mandatory)

Constant string value that represents the source application that initiated the event. Possible values: ACTIVITIES, BLOGS, BOOKMARKS, COMMUNITIES, FILES, HOMEPAGE, MOBILE, NEWS, PROFILES, SEARCH, WIKIS, IDEATIONBLOG. Additional values will be added as new applications are supported.
  • itemType (mandatory)

Constant string value that represents the content type. Used together with source to uniquely identify the content. For example, source=BLOGS, itemType=ENTRY for a Blog entry, source=WIKIS, itemType=PAGE for a Wiki page, etc.

Possible values: ABOUT, ACTIVITY, ATTACHMENT, BLOG, BOOKMARK, CATEGORY, COLLEAGUE, COMMENT, COMMUNITY, ENTRY, FEED, FILE, FILEVERSION, FOLDER, FORUM, IDEA, IDEABLOG, LIBRARY, LINK, MEMBERSHIP, PAGE, PERSON, PHOTO, REPLY, SHARE, STATUS, TAG, TODO, TOPIC, TRACKBACK, TRASH, WALLPOST, WATCHPERSON, WATCHTAG, WIDGET, WIKI, REPORT

  • contentId (mandatory)

Content uuid, for example, uuid for blog/blog entry/file/forum, etc.
  • eventType (mandatory)

Constant string value that represents the event type. For example, CREATE, UPDATE, READ. For read events from the UI, this value defaults to READ.
  • scope (optional)

Constant string value that represents the content scope type. For wxample, PUBLIC, PRIVATE. The default value is DEFAULT.
  • community (optional)

Community uuid, if available.
  • contentCorrelationId (optional)

Content correlation uuid (the parent content node uuid), if available, such as the blog uuid for which the comment was created.
  • contentContainerId (optional)

Content container id, if available.
  • contentContainerTitle (optional)

Content container title, if available.
  • contentTitle (optional)

Content title, if available.
  • contentLink (optional)

Content link, if available.
  • contentContainterLink (optional)

Content container link, if available.
  • contentCreatorId (optional)

Content creator id, if available.
  • contentCreateTs (optional)

Content create timestamp, if available.
  • clientCategory (optional) (Future support)

Constant string value that represents the user experience category that initiated the event. For example, native browser UI, Portlet, Mobile devices, API client. The default value is native browser UI.
  • clientType (optional) (Future support)

Constant string value that represents the user experience type that initiated the event. For example, Mobile device type (Iphone, Ipad, Android, Blackberry, etc.), API client type (Notes activity sidebar, etc). The default value is native browser UI.