Jump to

• Request
• Response

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.

Body ()

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.

{
    "description":"V1 People Statistics Filter Information DTO.",
    "properties":{
        "excludeFavoritesCount":{
            "description":"Exclude the favorites count statistic.",
            "type":"boolean"
        },
        "excludeFlagsCount":{
            "description":"Exclude the flag count statistic.",
            "type":"boolean"
        },
        "excludeFollowersCount":{
            "description":"Exclude the followers count statistic.",
            "type":"boolean"
        },
        "excludeFollowingCount":{
            "description":"Exclude the following count statistic.",
            "type":"boolean"
        },
        "excludeNewConversationsCount":{
            "description":"Exclude the new conversations count statistic.",
            "type":"boolean"
        },
        "excludeSocialObjectsCount":{
            "description":"Exclude the social objects count statistic.",
            "type":"boolean"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

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.

{
    "description":"V1 People Statistic List Information DTO.",
    "properties":{
        "items":{
            "description":"The statistics being returned.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/XV1PeopleStatisticInfo"
            }
        },
        "hasMore":{
            "description":"If true, there are more items to be returned.",
            "type":"boolean"
        },
        "nextURL":{
            "description":"Next page URL for the list. Null if this is the last page.",
            "type":"string",
            "format":"url"
        },
        "previousURL":{
            "description":"Previous page URL for the list. Null if this is the first page.",
            "type":"string",
            "format":"url"
        },
        "total":{
            "description":"If specified, this is the total number of available items. Null if the total is unknown.",
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : items

Type: array

The statistics being returned.

Show Source

• Array of: object XV1PeopleStatisticInfo
  V1 People Statistic DTO.

{
    "description":"The statistics being returned.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/XV1PeopleStatisticInfo"
    }
}

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

{
    "description":"V1 People Statistic DTO.",
    "properties":{
        "count":{
            "description":"The statistic itself. Not null.",
            "type":"integer",
            "format":"int32"
        },
        "externalID":{
            "description":"The external ID if this statistic is about a social definition or gadget. Can be null.",
            "type":"string"
        },
        "gadgetID":{
            "$ref":"#/definitions/XObjectID"
        },
        "label":{
            "description":"Localized label if this statistic is about a social definition or gadget. Can be null.",
            "type":"string"
        },
        "name":{
            "description":"Name of the statistic. Not null.",
            "type":"string"
        },
        "type":{
            "$ref":"#/definitions/XV1PeopleStatisticTypeEnum"
        }
    }
}

Nested Schema : XV1PeopleStatisticTypeEnum

Type: object

Show Source

• field(optional): string
  Allowed Values: [ "FAVORITES_COUNT", "FLAGS_COUNT", "FOLLOWERS_COUNT", "FOLLOWING_COUNT", "NEW_CONVERSATIONS_COUNT", "SOCIAL_DEFINITION_TYPE" ]

  Statistics Types.

{
    "properties":{
        "field":{
            "type":"string",
            "description":"Statistics Types.",
            "enum":[
                "FAVORITES_COUNT",
                "FLAGS_COUNT",
                "FOLLOWERS_COUNT",
                "FOLLOWING_COUNT",
                "NEW_CONVERSATIONS_COUNT",
                "SOCIAL_DEFINITION_TYPE"
            ]
        }
    }
}

Back to Top