Get a filtered list of statistics.
get
/social/api/v1/people/{peopleID}/statistics
Request
Supported Media Types
- application/json
Path Parameters
-
peopleID: integer(int64)
The people ID. The object's unique identifier from a long integer representation.
Specify a filter to query.
Root Schema : XV1PeopleStatisticFilterInfo
Type:
object
V1 People Statistics Filter Information DTO.
Show Source
-
excludeFavoritesCount(optional):
boolean
Exclude the favorites count statistic.
-
excludeFlagsCount(optional):
boolean
Exclude the flag count statistic.
-
excludeFollowersCount(optional):
boolean
Exclude the followers count statistic.
-
excludeFollowingCount(optional):
boolean
Exclude the following count statistic.
-
excludeNewConversationsCount(optional):
boolean
Exclude the new conversations count statistic.
-
excludeSocialObjectsCount(optional):
boolean
Exclude the social objects count statistic.
Response
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : XV1PeopleStatisticListInfo
Type:
object
V1 People Statistic List Information DTO.
Show Source
-
hasMore(optional):
boolean
If true, there are more items to be returned.
-
items(optional):
array items
The statistics being returned.
-
nextURL(optional):
string(url)
Next page URL for the list. Null if this is the last page.
-
previousURL(optional):
string(url)
Previous page URL for the list. Null if this is the first page.
-
total(optional):
integer(int32)
If specified, this is the total number of available items. Null if the total is unknown.
Nested Schema : items
Type:
array
The statistics being returned.
Show Source
-
Array of:
object XV1PeopleStatisticInfo
V1 People Statistic DTO.
Nested Schema : XV1PeopleStatisticInfo
Type:
object
V1 People Statistic DTO.
Show Source
-
count(optional):
integer(int32)
The statistic itself. Not null.
-
externalID(optional):
string
The external ID if this statistic is about a social definition or gadget. Can be null.
-
gadgetID(optional):
An object's unique identifier from a long integer representation.
-
label(optional):
string
Localized label if this statistic is about a social definition or gadget. Can be null.
-
name(optional):
string
Name of the statistic. Not null.
-
type(optional):
object XV1PeopleStatisticTypeEnum
Nested Schema : XV1PeopleStatisticTypeEnum
Type:
Show Source
object
-
field(optional):
string
Allowed Values:
[ "FAVORITES_COUNT", "FLAGS_COUNT", "FOLLOWERS_COUNT", "FOLLOWING_COUNT", "NEW_CONVERSATIONS_COUNT", "SOCIAL_DEFINITION_TYPE" ]
Statistics Types.