Loading ...

REST API: Get Most Active Spaces | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Analytics » REST API: Get Most Active Spaces
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 3

REST API: Get Most Active Spaces

0 
 /5
0 (0votes)

Get Most Active Spaces

GET /api/analytics/spaces/active

Get a list of the most active spaces. Valid for Communifire version 7.0 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
7.0 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)

Communifire REST API key for the Communifire portal you are making the call for.
Optional Parameters How to use Description
FromDate &FromDate=x - Used in the request URL as a query parameter Specifies the date range. The date format is YYYY-MM-DD:HH:mm:ssZ.
ToDate &ToDate=x - Used in the request URL as a query parameter Specifies the date range. The date format is YYYY-MM-DD:HH:mm:ssZ.
Size &Size=x - Used in the request URL as a query parameter Specifies how many spaces to return. The default value is 10.

Example Request

GET https://myintranet.communifire.com/api/analytics/spaces/active?FromDate=20210426&ToDate=20210525&Size=2

Example Response

Space JSON object is returned as ResponseData.


{
  "IsError": false,
  "ResponseData": [
    {
      "IDProperty": "13-252",
      "Title": "Human Resources",
      "Summary": "A space dedicated to all your human resources needs and questions. Access company policies, benefits, perks, and more. Get help from the team and ask questions.",
      "IsIsolated": false,
      "ContentTitleFilterApplied": "Human Resources",
      "ContentTitleFilterAppliedEnglish": "Human Resources",
      "ContentTitleWithoutDecodeLower": "human resources",
      "ContentSummaryFilteredApplied": "A space dedicated to all your human resources needs and questionsdot Access company policies, benefits, perks, and moredot Get help from the team and ask questionsdot",
      "ContentSummaryFilteredAppliedEnglish": "A space dedicated to all your human resources needs and questionsdot Access company policies, benefits, perks, and moredot Get help from the team and ask questionsdot",
      "ContentSummaryFilteredAppliedWithSpecialCharactersStripped": "A space dedicated to all your human resources needs and questions  Access company policies, benefits, perks, and more  Get help from the team and ask questions ",
      "ContentBodyHtmlStripped": "A space dedicated to all your human resources needs and questions. Access company policies, benefits, perks, and more. Get help from the team and ask questions.",
      "ContentBodyFilteredApplied": "A space dedicated to all your human resources needs and questionsdot Access company policies, benefits, perks, and moredot Get help from the team and ask questionsdot",
      "ContentBodyFilteredAppliedEnglish": "A space dedicated to all your human resources needs and questionsdot Access company policies, benefits, perks, and moredot Get help from the team and ask questionsdot",
      "ContentBodyFilteredWithSpecialCharactersStripped": "A space dedicated to all your human resources needs and questions  Access company policies, benefits, perks, and more  Get help from the team and ask questions ",
      "WallPostToUserID": 0,
      "PermissionCheckAuthorID": 376,
      "SpaceRoleIDCSV": [
        "1109",
        "1110",
        "1111",
        "1112"
      ],
      "SpaceRoleIDCsvViewAll": [
        "1109",
        "1110",
        "1111",
        "1112"
      ],
      "Body": "",
      "DateCreated": "2017-07-04T08:05:31.37",
      "DatePublished": "2017-07-04T08:05:31.37",
      "DateUpdated": "0001-01-01T00:00:00",
      "ShowDate": true,
      "ShowMetaData": true,
      "DateCreatedString": "7/4/2017",
      "DatePublishedString": "7/4/2017",
      "AuthorUserID": 376,
      "AuthorUsername": "admin",
      "AuthorUserDisplayName": "Alexis Fox",
      "AuthorUserAvatarImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/376/1c32c413-8025-4da5-b23a-575ab251faf4.png",
      "AuthorUserProfileURL": "https://myintranet.communifire.com/people/admin",
      "SpaceID": 0,
      "ContentStatusID": 0,
      "ContentCurrentWorkFlowStepID": 0,
      "EntityType": 13,
      "EntityTypeText": "Space",
      "ContentID": 252,
      "ContentURL": "/spaces/252/human-resources/hr-homepage",
      "ContentURLFilterApplied": "forwardslashspacesforwardslash252forwardslashhumanhyphenresourcesforwardslashhrhyphenhomepage",
      "ContentImageURL": "https://myintranet.communifire.com/Assets/Uploaded-CMS-Files/SpacesFiles/252/46283b79-6c58-4f71-8e13-e1414b688dd5_icon.png",
      "ContentMediaServerID": 24,
      "WallID": 0,
      "GreatGrandParentContentID": 0,
      "ForumPostForumID": 0,
      "ForumPostTopicID": 0,
      "EntityIconCssClass": "icon-globe",
      "IsExternalContent": false,
      "ParentEntityType": 0,
      "ParentContentID": 0,
      "ContentDetailImageURL": "https://myintranet.communifire.com/Assets/Uploaded-CMS-Files/SpacesFiles/252/46283b79-6c58-4f71-8e13-e1414b688dd5.png",
      "ContentFeaturedImage": "46283b79-6c58-4f71-8e13-e1414b688dd5_icon.png",
      "ContentDetailImageName": "46283b79-6c58-4f71-8e13-e1414b688dd5.png",
      "UserIsProfilePublic": false,
      "UserIsActivated": false,
      "CommentCount": 0,
      "LikeCount": 0,
      "PageViews": 0,
      "Rating": 0.0,
      "IsComment": false,
      "IsSpaceLevel": true,
      "IsFeatured": true,
      "IsLatest": false,
      "IsContentPubliclyAccessible": true,
      "IsAddedFromActivityStream": false,
      "ShowRating": false,
      "ShowViewCount": false,
      "ShowCommentCount": false,
      "EventStartDate": "0001-01-01T00:00:00",
      "IsRecurringTime": false,
      "EventEndDate": "0001-01-01T00:00:00",
      "EventScheduleStartDate": "0001-01-01T00:00:00",
      "EventScheduleEndDate": "0001-01-01T00:00:00",
      "EventCountryID": 0,
      "EventStateID": 0,
      "EventMetroID": 0,
      "EventIsAllDay": false,
      "EventIsPrivate": false,
      "EventTypeID": 0,
      "SpaceVisibility": 0,
      "TotalChildRecords": 0,
      "IsAwardPost": false,
      "AwardID": 0,
      "MembershipContentID": 0,
      "ConnectedToUser": false,
      "IssueCommentIsProjectActive": false,
      "IssueCommentIsInternal": false,
      "IssueCommentIssueID": 0,
      "ActivityActionEnum": 0,
      "ActivityLogBrowserType": 0,
      "ActivityLogOperatingSys": 0,
      "ActivityLogUserID": 0,
      "IndexedContentType": 4,
      "IsRequiredReading": false,
      "IsRequiredReadingConfirmed": false,
      "ContentVersionID": 0,
      "IsAnonymous": false
    },
    {
      "IDProperty": "13-256",
      "Title": "Information Technology",
      "Summary": "Submit your help desk and tech questions here.",
      "IsIsolated": false,
      "ContentTitleFilterApplied": "Information Technology",
      "ContentTitleFilterAppliedEnglish": "Information Technology",
      "ContentTitleWithoutDecodeLower": "information technology",
      "ContentSummaryFilteredApplied": "Submit your help desk and tech questions heredot",
      "ContentSummaryFilteredAppliedEnglish": "Submit your help desk and tech questions heredot",
      "ContentSummaryFilteredAppliedWithSpecialCharactersStripped": "Submit your help desk and tech questions here ",
      "ContentBodyHtmlStripped": "Submit your help desk and tech questions here.",
      "ContentBodyFilteredApplied": "Submit your help desk and tech questions heredot",
      "ContentBodyFilteredAppliedEnglish": "Submit your help desk and tech questions heredot",
      "ContentBodyFilteredWithSpecialCharactersStripped": "Submit your help desk and tech questions here ",
      "WallPostToUserID": 0,
      "PermissionCheckAuthorID": 376,
      "SpaceRoleIDCSV": [
        "1125",
        "1126",
        "1127",
        "1128"
      ],
      "SpaceRoleIDCsvViewAll": [
        "1125",
        "1126",
        "1127",
        "1128"
      ],
      "Body": "",
      "DateCreated": "2017-11-14T03:00:15.5",
      "DatePublished": "2017-11-14T03:00:15.5",
      "DateUpdated": "0001-01-01T00:00:00",
      "ShowDate": true,
      "ShowMetaData": true,
      "DateCreatedString": "11/13/2017",
      "DatePublishedString": "11/13/2017",
      "AuthorUserID": 376,
      "AuthorUsername": "admin",
      "AuthorUserDisplayName": "Alexis Fox",
      "AuthorUserAvatarImageURL": "https://myintranet.communifire.com/Assets/Uploaded-Photos/376/1c32c413-8025-4da5-b23a-575ab251faf4.png",
      "AuthorUserProfileURL": "https://myintranet.communifire.com/people/admin",
      "SpaceID": 0,
      "ContentStatusID": 0,
      "ContentCurrentWorkFlowStepID": 0,
      "EntityType": 13,
      "EntityTypeText": "Space",
      "ContentID": 256,
      "ContentURL": "/spaces/256/information-technology",
      "ContentURLFilterApplied": "forwardslashspacesforwardslash256forwardslashinformationhyphentechnology",
      "ContentImageURL": "https://myintranet.communifire.com/Assets/Uploaded-CMS-Files/SpacesFiles/256/02704bbe-ef30-455a-8f31-3c0a242e6b3a_icon.jpg",
      "ContentMediaServerID": 24,
      "WallID": 0,
      "GreatGrandParentContentID": 0,
      "ForumPostForumID": 0,
      "ForumPostTopicID": 0,
      "EntityIconCssClass": "icon-globe",
      "IsExternalContent": false,
      "ParentEntityType": 0,
      "ParentContentID": 0,
      "ContentDetailImageURL": "https://myintranet.communifire.com/Assets/Uploaded-CMS-Files/SpacesFiles/256/02704bbe-ef30-455a-8f31-3c0a242e6b3a.jpg",
      "ContentFeaturedImage": "02704bbe-ef30-455a-8f31-3c0a242e6b3a_icon.jpg",
      "ContentDetailImageName": "02704bbe-ef30-455a-8f31-3c0a242e6b3a.jpg",
      "UserIsProfilePublic": false,
      "UserIsActivated": false,
      "CommentCount": 0,
      "LikeCount": 0,
      "PageViews": 0,
      "Rating": 0.0,
      "IsComment": false,
      "IsSpaceLevel": true,
      "IsFeatured": true,
      "IsLatest": false,
      "IsContentPubliclyAccessible": true,
      "IsAddedFromActivityStream": false,
      "ShowRating": false,
      "ShowViewCount": false,
      "ShowCommentCount": false,
      "EventStartDate": "0001-01-01T00:00:00",
      "IsRecurringTime": false,
      "EventEndDate": "0001-01-01T00:00:00",
      "EventScheduleStartDate": "0001-01-01T00:00:00",
      "EventScheduleEndDate": "0001-01-01T00:00:00",
      "EventCountryID": 0,
      "EventStateID": 0,
      "EventMetroID": 0,
      "EventIsAllDay": false,
      "EventIsPrivate": false,
      "EventTypeID": 0,
      "SpaceVisibility": 0,
      "TotalChildRecords": 0,
      "IsAwardPost": false,
      "AwardID": 0,
      "MembershipContentID": 0,
      "ConnectedToUser": false,
      "IssueCommentIsProjectActive": false,
      "IssueCommentIsInternal": false,
      "IssueCommentIssueID": 0,
      "ActivityActionEnum": 0,
      "ActivityLogBrowserType": 0,
      "ActivityLogOperatingSys": 0,
      "ActivityLogUserID": 0,
      "IndexedContentType": 4,
      "IsRequiredReading": false,
      "IsRequiredReadingConfirmed": false,
      "ContentVersionID": 0,
      "IsAnonymous": false
    }
  ]
}

 

Please Note Pass application/json as the content type in the header of your request.

Wiki Index

Pages

Intranet Software