POST api/Account/GetUserHistory

Gets users' history of activities. Pagination is supported.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Username	Filter by username, if set	string	None.
FromUtc	Filter by date, if set	date	None.
UntilUtc	Filter by date, if set	date	None.
ActivityType	Filter by type, if set	EventTypeEnum	None.
PageIndex	Optional page index (default is 0).	integer	None.
PageSize	Optional page size (default is 1000).	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Username": null,
  "FromUtc": null,
  "UntilUtc": null,
  "ActivityType": null,
  "PageIndex": 1,
  "PageSize": 1000
}

application/xml, text/xml

Sample:

<UserHistoryFilterPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Posts">
  <ActivityType i:nil="true" />
  <FromUtc i:nil="true" />
  <PageIndex>1</PageIndex>
  <PageSize>1000</PageSize>
  <UntilUtc i:nil="true" />
  <Username i:nil="true" />
</UserHistoryFilterPost>

Response Information

Resource Description

GetUserHistoryResult

Name	Description	Type	Additional information
History	A page with user histories.	UserHistory	None.

Response Formats

application/json, text/json

Sample:

{
  "History": {
    "PageIndex": 1,
    "PageSize": 10,
    "TotalItems": 1,
    "TotalPages": 1,
    "Items": [
      {
        "Username": "john.doe",
        "DateUtc": "2024-04-28T02:03:39.5280153Z",
        "Ip": "192.168.1.1",
        "Source": 1
      }
    ]
  }
}

application/xml, text/xml

Sample:

<GetUserHistoryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
  <History>
    <Items>
      <GetUserHistoryResult.UserHistory>
        <DateUtc>2024-04-28T02:03:39.5280153Z</DateUtc>
        <Ip>192.168.1.1</Ip>
        <Source>Web</Source>
        <Username>john.doe</Username>
      </GetUserHistoryResult.UserHistory>
    </Items>
    <PageIndex>1</PageIndex>
    <PageSize>10</PageSize>
    <TotalItems>1</TotalItems>
    <TotalPages>1</TotalPages>
  </History>
</GetUserHistoryResult>