GET api/group/mostactive?pageSize={pageSize}

Return the Groups with the most viewings between a given date range, ordered by viewing Count

Request Information

URI Parameters

NameDescriptionTypeAdditional information
RangeFrom

date

None.

RangeTo

date

None.

BranchId

integer

None.

RoleTypes

Collection of string

None.

pageSize

integer

Default value is 7

Body Parameters

None.

Response Information

Resource Description

PagedCollectionDataContractOfMostActiveGroupDataContract
NameDescriptionTypeAdditional information
TotalCount

integer

None.

CurrentCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

Collection

Collection of MostActiveGroupDataContract

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "OwningTeamId": 1,
      "BranchId": 2,
      "Name": "sample string 3",
      "TeamAccessType": "sample string 4",
      "Description": "sample string 5",
      "GroupType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "GroupIcon": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Members": [
        {
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 1",
          "FirstName": "sample string 2",
          "LastName": "sample string 3",
          "ContactName": "sample string 4",
          "PrimaryTelephone": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "PrimaryEmail": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "Id": 5
        },
        {
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 1",
          "FirstName": "sample string 2",
          "LastName": "sample string 3",
          "ContactName": "sample string 4",
          "PrimaryTelephone": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "PrimaryEmail": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "Id": 5
        }
      ],
      "PrimaryMemberId": 6,
      "Address": {
        "Location": {
          "CenterPoint": {
            "Latitude": 1.1,
            "Longitude": 2.1,
            "Altitude": 3.1,
            "Order": 4,
            "Id": 5
          },
          "Extent": [
            {
              "Latitude": 1.1,
              "Longitude": 2.1,
              "Altitude": 3.1,
              "Order": 4,
              "Id": 5
            },
            {
              "Latitude": 1.1,
              "Longitude": 2.1,
              "Altitude": 3.1,
              "Order": 4,
              "Id": 5
            }
          ],
          "ViewPoints": [
            {
              "Point": {
                "Latitude": 1.1,
                "Longitude": 2.1,
                "Altitude": 3.1,
                "Order": 4,
                "Id": 5
              },
              "Pitch": 1.1,
              "Heading": 2.1,
              "FieldOfVision": 3.1,
              "Zoom": 4.1,
              "Label": "sample string 5",
              "Id": 6
            },
            {
              "Point": {
                "Latitude": 1.1,
                "Longitude": 2.1,
                "Altitude": 3.1,
                "Order": 4,
                "Id": 5
              },
              "Pitch": 1.1,
              "Heading": 2.1,
              "FieldOfVision": 3.1,
              "Zoom": 4.1,
              "Label": "sample string 5",
              "Id": 6
            }
          ],
          "Id": 1
        },
        "AddressSource": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "SourceId": "sample string 1",
        "OrganizationName": "sample string 2",
        "Number": "sample string 3",
        "BuildingName": "sample string 4",
        "Street": "sample string 5",
        "Town": "sample string 6",
        "Locality": "sample string 7",
        "County": "sample string 8",
        "Postcode": "sample string 9",
        "CreatedDate": "2020-12-04T07:49:20.6975775Z",
        "CreatedBy": {
          "Initials": "sample string 1",
          "ContactName": "sample string 2",
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 3",
          "FirstName": "sample string 4",
          "LastName": "sample string 5",
          "PrimaryTelephone": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "PrimaryEmail": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "JobTitle": "sample string 6",
          "Id": 7
        },
        "Id": 11
      },
      "ViewingCount": 7,
      "OfferCount": 8,
      "TelephoneCount": 9,
      "MailoutCount": 10,
      "Id": 11
    },
    {
      "OwningTeamId": 1,
      "BranchId": 2,
      "Name": "sample string 3",
      "TeamAccessType": "sample string 4",
      "Description": "sample string 5",
      "GroupType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "GroupIcon": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Members": [
        {
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 1",
          "FirstName": "sample string 2",
          "LastName": "sample string 3",
          "ContactName": "sample string 4",
          "PrimaryTelephone": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "PrimaryEmail": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "Id": 5
        },
        {
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 1",
          "FirstName": "sample string 2",
          "LastName": "sample string 3",
          "ContactName": "sample string 4",
          "PrimaryTelephone": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "PrimaryEmail": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "Id": 5
        }
      ],
      "PrimaryMemberId": 6,
      "Address": {
        "Location": {
          "CenterPoint": {
            "Latitude": 1.1,
            "Longitude": 2.1,
            "Altitude": 3.1,
            "Order": 4,
            "Id": 5
          },
          "Extent": [
            {
              "Latitude": 1.1,
              "Longitude": 2.1,
              "Altitude": 3.1,
              "Order": 4,
              "Id": 5
            },
            {
              "Latitude": 1.1,
              "Longitude": 2.1,
              "Altitude": 3.1,
              "Order": 4,
              "Id": 5
            }
          ],
          "ViewPoints": [
            {
              "Point": {
                "Latitude": 1.1,
                "Longitude": 2.1,
                "Altitude": 3.1,
                "Order": 4,
                "Id": 5
              },
              "Pitch": 1.1,
              "Heading": 2.1,
              "FieldOfVision": 3.1,
              "Zoom": 4.1,
              "Label": "sample string 5",
              "Id": 6
            },
            {
              "Point": {
                "Latitude": 1.1,
                "Longitude": 2.1,
                "Altitude": 3.1,
                "Order": 4,
                "Id": 5
              },
              "Pitch": 1.1,
              "Heading": 2.1,
              "FieldOfVision": 3.1,
              "Zoom": 4.1,
              "Label": "sample string 5",
              "Id": 6
            }
          ],
          "Id": 1
        },
        "AddressSource": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "SourceId": "sample string 1",
        "OrganizationName": "sample string 2",
        "Number": "sample string 3",
        "BuildingName": "sample string 4",
        "Street": "sample string 5",
        "Town": "sample string 6",
        "Locality": "sample string 7",
        "County": "sample string 8",
        "Postcode": "sample string 9",
        "CreatedDate": "2020-12-04T07:49:20.6975775Z",
        "CreatedBy": {
          "Initials": "sample string 1",
          "ContactName": "sample string 2",
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 3",
          "FirstName": "sample string 4",
          "LastName": "sample string 5",
          "PrimaryTelephone": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "PrimaryEmail": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "JobTitle": "sample string 6",
          "Id": 7
        },
        "Id": 11
      },
      "ViewingCount": 7,
      "OfferCount": 8,
      "TelephoneCount": 9,
      "MailoutCount": 10,
      "Id": 11
    }
  ]
}