Activity resource

User activity

OVERVIEW

There are three key activity areas in Collaborate. 

  1. Dashboard activity
  2. Site Activity
  3. User Activity

The purpose of this API method is to provide the user activity. The user activity API has been separated from the activity API, due to multiple reasons listed below

  • The user activity should include activity from MySite which does not exist in Dashboard activity and hence in Activity API
  • The user activity includes personal actions like viewing documents, which can flood the dashboard activity feed
  • The folder views do not need to be included in the activity stream, however creation of folder should be included in the user activity stream. 
  • When the document is download from the server using the API, a download audit should be recorded for that activity
  • Once the document is downloaded and is cached on the client, any view action should be recorded as an additional activity, and should be posted to the server. ( e.g on iOS device, if the local cache of the document does not send a download call on each click in the activity stream, then we should register it as a view option on each view on the iOS device )
  • The activity should have the site filter to get user activity specific to a site
  • The activity API should have a content filter to filter the activity based on a specific content. 

Technical Considerations

The Activities are 

  • Add 
  • Update ( Add version)
  • View
  • Download
  • File saved from Microsoft Office
  • File opened in Microsoft Office

Request URL 

GET      /users/activities

 

 

Parameter Name Value Description
site String
  • Site 

    /users/activities?site=<siteid>

    If site id is provided , the parameter for sitescope is ignored, sitescope parameter is only considered when no site id is given. 
     

  • Predefined grouping of sites

    /user/activities?sitescope={all / memberoff /favourite}  (The all parameter only applies to a user who is a system admin)
contenttype String The type of content to filter by. Default is Files, however you can filter by all content types available in the activitiy stream like

/users/activities?contenttype=files

  • Files

errata (The user activity only supports files and we have decided not to support other content types as they are available through the normal activity API)
offset int the no of last activity fetched. 
limit int No of items to return. Default is 20 (Max is 100 , Activity to a maximum of 3 months can be provided)

 

Response

<activities>
 <activity>
          <activitydesc></activitydesc>
          <timepublished>UTC date</timepublished>
          <sitename></sitename>
          <siteid></siteid>
          <siterole></siterole>  {Role of the API use for the specific site}
          <contentitem>
                <id></id>
                <title></title>
                <link>{URL to the content on HighQ Collaborate, this is not an API endpoint link}</link>
                <apilink></apilink> {ALL api endpoints have not yet been developed, so we will only provide the API link if it is available , e.g file link or micro blog}
                <type>{Content type}</type>
                <location></location> {In case of file this will be the path to the file, in case of wiki this will be the path to the wiki page, category in case of other content types, where it applies}
                <filetype>{content type extension}</filetype>
                <filesize>14399</filesize>
                <siterootfolderid>210</siterootfolderid>
                <author>
                        <username></username>
                        <email>Email Address</email>
                        <avatar></avatar>
                        <userlink></userlink>  ( link to the users profile )
                </author>
                <datepublished></datepublished>
                <parentcontent> {In case of file, what is the parent content to which the content item belongs too}
                        <title></title>
                        <link></link>
                        <apilink></apilink> {ALL api endpoints have not yet been developed, so we will only provide the API link if it is available , e.g file link or micro blog}
                </parentcontent>
             <comments>
                          <comment>
                         <text></text>
                         <author>
                                    <username></username>
                                    <email>Email Address</email>
                                    <avatar></avatar>
                                    <userlink></userlink>  ( link to the users profile )
                          </author>
                          <datepublished></datepublished>
                         <nooflikes></nooflikes>
                        <images>
                                 <image>
                                 <imagelink> </imagelink>
                                 </image>
                         <images>
                         </comment>
              </comments>
              <images>
                        <image>
                         <imagelink> </imagelink>
                        </image>
               </images>
          <contentitem>
 </activity>
 <activities>

 

 

 

Comments


0 Comments

Last Updated: Jun 09,2023