Agentivity API

<back to all web services

GetAppUsersActivity

The following routes are available for this service:
GET/AppUsersActivity
GetAppUsersActivity Parameters:
NameParameterData TypeRequiredDescription
UsernamequerystringYesUserName in form of an email address
DateStartquerystringYesDate in format YYYYMMDD
DateEndquerystringYesDate in format YYYYMMDD
ExcludeFrequentNonReportActivitiesquerybooleanNoExcludes frequent activities not related to reports
ExcludeEmailSubscriptionsquerybooleanNoExcludes activities related to email subscriptions
UserquerystringNoFilter by specific user
PagingMetadata Parameters:
NameParameterData TypeRequiredDescription
OffsetquerystringNoStarting Record
LimitquerystringNoNumber of records to return (PageSize)
TotalRecordsquerystringNoTotal Number of Records in a Full Reponse (if no paging)
ResponseRecordsquerystringNoTotal Number of Records in this Reponse (on this page)
CollectionResponse<TItem> Parameters:
NameParameterData TypeRequiredDescription
ResponseMetadataformResponseMetadataNo
ResponseReportformList<TItem>No
ResponseErrorformAgentivityErrorNo
ResponseMetadata Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
HasCacheformboolNo
HasPagingformboolNo
CacheMetadataformCacheMetadataNo
PagingMetadataformPagingMetadataNo
CacheMetadata Parameters:
NameParameterData TypeRequiredDescription
CachedAtformDateTimeNo
CacheExpiresAtformDateTimeNo
IsFromCacheformboolNo
AgentivityError Parameters:
NameParameterData TypeRequiredDescription
ErrorCodeformstringNo
MessageformstringNo
StatusCodeformstringNo
VerboseMessageformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET //AppUsersActivity HTTP/1.1 
Host: api.agentivity.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseMetadata":{"Success":false,"HasCache":false,"HasPaging":false,"CacheMetadata":{"IsFromCache":false,"CachedAt":"\/Date(-62135596800000-0000)\/","CacheExpiresAt":"\/Date(-62135596800000-0000)\/"},"PagingMetadata":{"Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}},"ResponseReport":[{"User":"String","FirstName":"String","LastName":"String","ActivityDateTime":"\/Date(-62135596800000-0000)\/","Activity":"String","IsDownload":false,"RequestDetails":"String"}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}