POST api/list/stats/groupinterests
Group Interests. Processes this list stats API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
None.
Body Parameters
The filters value supplied with the request.
Collection of GroupInterestListFilterDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| InterestFlags |
The collection of interest flags. |
Collection of string |
None. |
| Origins |
The collection of origins. |
Collection of string |
None. |
| Grades |
The collection of grades. |
Collection of string |
None. |
| RoleTypes |
The collection of role types. |
Collection of string |
None. |
| RoleStatuses |
The collection of role statuses. |
Collection of string |
None. |
| LastContactedFrom |
The last contacted from, expressed as a date and time. |
date |
None. |
| LastContactedTo |
The last contacted to, expressed as a date and time. |
date |
None. |
| LastContacted |
The last contacted value. |
DateRangeFilterDataContract |
None. |
| CreatedFrom |
The created from, expressed as a date and time. |
date |
None. |
| CreatedTo |
The created to, expressed as a date and time. |
date |
None. |
| Created |
The created value. |
DateRangeFilterDataContract |
None. |
| LandlordVendorFrom |
The landlord vendor from, expressed as a date and time. |
date |
None. |
| LandlordVendorTo |
The landlord vendor to, expressed as a date and time. |
date |
None. |
| LandlordVendor |
The landlord vendor value. |
DateRangeFilterDataContract |
None. |
| Sort |
The sort classification. |
GroupInterestListSort |
None. |
| GroupIds |
The unique identifiers of the related group resources. |
Collection of integer |
None. |
| OwningTeamIds |
The unique identifiers of the related owning team resources. |
Collection of integer |
None. |
| RoleIds |
The unique identifiers of the related role resources. |
Collection of integer |
None. |
| AdditionalIds |
The unique identifiers of the related additional resources. |
Collection of integer |
None. |
| ExcludedIds |
The unique identifiers of the related excluded resources. |
Collection of integer |
None. |
| ExcludeHasNoEmail |
Indicates whether exclude has no email is true. |
boolean |
None. |
| IsMarketingRoleTypeSearch |
Indicates whether this item is marketing role type search. |
boolean |
None. |
| HasValuationBooked |
Indicates whether this item has valuation booked. |
boolean |
None. |
| HasSearch |
Indicates whether this item has search. |
boolean |
None. |
| CompanyTypes |
The collection of company types. |
Collection of string |
None. |
| Archived |
Indicates whether archived is true. |
boolean |
None. |
| Name |
The name value. |
string |
None. |
| CustomFilterConfig |
The custom filter config value. |
string |
None. |
| BranchId |
The unique identifier of the related branch resource. |
integer |
None. |
| BranchIds |
The unique identifiers of the related branch resources. |
Collection of integer |
None. |
| EventBranchIds |
The unique identifiers of the related event branch resources. |
Collection of integer |
None. |
| Order |
The order classification. |
ListOrder |
None. |
| SearchTerm |
The search term value. |
string |
None. |
| FilterType |
The filter type value. |
EnumDataContract |
None. |
| ShowDeleted |
Indicates whether show deleted is true. |
boolean |
None. |
| ShowCancelled |
Indicates whether show cancelled is true. |
boolean |
None. |
| OwningTeamId |
The unique identifier of the related owning team resource. |
integer |
None. |
| Id |
The unique identifier of this resource. |
integer |
None. |
Request Formats
application/x-www-form-urlencoded
Sample not available.
application/json, text/json
[
{
"InterestFlags": [
"sample string 1",
"sample string 2"
],
"Origins": [
"sample string 1",
"sample string 2"
],
"Grades": [
"sample string 1",
"sample string 2"
],
"RoleTypes": [
"sample string 1",
"sample string 2"
],
"RoleStatuses": [
"sample string 1",
"sample string 2"
],
"LastContactedFrom": "2026-07-23T10:37:11.7494008Z",
"LastContactedTo": "2026-07-23T10:37:11.7494008Z",
"LastContacted": {
"FromStaticDate": "2026-07-23T10:37:11.7494008Z",
"ToStaticDate": "2026-07-23T10:37:11.7494008Z",
"PredefinedDateRange": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FromExpression": "sample string 1",
"ToExpression": "sample string 2",
"Id": 3
},
"CreatedFrom": "2026-07-23T10:37:11.7494008Z",
"CreatedTo": "2026-07-23T10:37:11.7494008Z",
"Created": {
"FromStaticDate": "2026-07-23T10:37:11.7494008Z",
"ToStaticDate": "2026-07-23T10:37:11.7494008Z",
"PredefinedDateRange": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FromExpression": "sample string 1",
"ToExpression": "sample string 2",
"Id": 3
},
"LandlordVendorFrom": "2026-07-23T10:37:11.7494008Z",
"LandlordVendorTo": "2026-07-23T10:37:11.7494008Z",
"LandlordVendor": {
"FromStaticDate": "2026-07-23T10:37:11.7494008Z",
"ToStaticDate": "2026-07-23T10:37:11.7494008Z",
"PredefinedDateRange": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FromExpression": "sample string 1",
"ToExpression": "sample string 2",
"Id": 3
},
"Sort": 0,
"GroupIds": [
1,
2
],
"OwningTeamIds": [
1,
2
],
"RoleIds": [
1,
2
],
"AdditionalIds": [
1,
2
],
"ExcludedIds": [
1,
2
],
"ExcludeHasNoEmail": true,
"IsMarketingRoleTypeSearch": true,
"HasValuationBooked": true,
"HasSearch": true,
"CompanyTypes": [
"sample string 1",
"sample string 2"
],
"Archived": true,
"Name": "sample string 2",
"CustomFilterConfig": "sample string 3",
"BranchId": 1,
"BranchIds": [
1,
2
],
"EventBranchIds": [
1,
2
],
"Order": 0,
"SearchTerm": "sample string 4",
"FilterType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"ShowDeleted": true,
"ShowCancelled": true,
"OwningTeamId": 7,
"Id": 8
},
{
"InterestFlags": [
"sample string 1",
"sample string 2"
],
"Origins": [
"sample string 1",
"sample string 2"
],
"Grades": [
"sample string 1",
"sample string 2"
],
"RoleTypes": [
"sample string 1",
"sample string 2"
],
"RoleStatuses": [
"sample string 1",
"sample string 2"
],
"LastContactedFrom": "2026-07-23T10:37:11.7494008Z",
"LastContactedTo": "2026-07-23T10:37:11.7494008Z",
"LastContacted": {
"FromStaticDate": "2026-07-23T10:37:11.7494008Z",
"ToStaticDate": "2026-07-23T10:37:11.7494008Z",
"PredefinedDateRange": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FromExpression": "sample string 1",
"ToExpression": "sample string 2",
"Id": 3
},
"CreatedFrom": "2026-07-23T10:37:11.7494008Z",
"CreatedTo": "2026-07-23T10:37:11.7494008Z",
"Created": {
"FromStaticDate": "2026-07-23T10:37:11.7494008Z",
"ToStaticDate": "2026-07-23T10:37:11.7494008Z",
"PredefinedDateRange": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FromExpression": "sample string 1",
"ToExpression": "sample string 2",
"Id": 3
},
"LandlordVendorFrom": "2026-07-23T10:37:11.7494008Z",
"LandlordVendorTo": "2026-07-23T10:37:11.7494008Z",
"LandlordVendor": {
"FromStaticDate": "2026-07-23T10:37:11.7494008Z",
"ToStaticDate": "2026-07-23T10:37:11.7494008Z",
"PredefinedDateRange": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FromExpression": "sample string 1",
"ToExpression": "sample string 2",
"Id": 3
},
"Sort": 0,
"GroupIds": [
1,
2
],
"OwningTeamIds": [
1,
2
],
"RoleIds": [
1,
2
],
"AdditionalIds": [
1,
2
],
"ExcludedIds": [
1,
2
],
"ExcludeHasNoEmail": true,
"IsMarketingRoleTypeSearch": true,
"HasValuationBooked": true,
"HasSearch": true,
"CompanyTypes": [
"sample string 1",
"sample string 2"
],
"Archived": true,
"Name": "sample string 2",
"CustomFilterConfig": "sample string 3",
"BranchId": 1,
"BranchIds": [
1,
2
],
"EventBranchIds": [
1,
2
],
"Order": 0,
"SearchTerm": "sample string 4",
"FilterType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"ShowDeleted": true,
"ShowCancelled": true,
"OwningTeamId": 7,
"Id": 8
}
]
Response Information
Resource Description
The response returned after the operation completes.
PagedCollectionDataContractOfListStatsDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalCount |
The total count value. |
integer |
None. |
| CurrentCount |
The current count value. |
integer |
None. |
| PageSize |
The page size value. |
integer |
None. |
| PageNumber |
The page number value. |
integer |
None. |
| Collection |
The collection of collection. |
Collection of ListStatsDataContract |
None. |
Response Formats
application/json, text/json
{
"TotalCount": 1,
"CurrentCount": 2,
"PageSize": 1,
"PageNumber": 1,
"Collection": [
{
"Name": "sample string 1",
"Value": 2
},
{
"Name": "sample string 1",
"Value": 2
}
]
}