Loading ...

REST API: Get My Spaces Analytics | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Spaces » REST API: Get My Spaces Analytics
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 2

REST API: Get My Spaces Analytics

0 
 /5
0 (0votes)

Get My Spaces Analytics

GET  /api/spaces/analytics

Allows a member to get all his spaces analytics. Valid for Communifire version 6.0 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
6.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
From &from=x - Used in the request URL (see below) Content creation date matches with from date, which should be greater than From date.
To &to=x - Used in the request URL (see below) Content creation date matches with to date, which should be smaller than To date.
CategoryName &categoryname=x - Used in the request URL (see below) Unique name used to represent a content category.

Please Note Date format should match with the date format on current user's preferences page.

Example URL: https://your-community.com/api/spaces/analytics?from=01/06/2019&to=25/06/2019&categoryname=News

Response JSON sample where space analytics JSON object is returned as ResponseData


{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
     "SpaceID": 0,
     "SpaceName": "Top level community",
     "NewContentCount": 9
    },
    {
     "SpaceID": 257,
     "SpaceName": "Company Announcements and Corporate News Center",
     "NewContentCount": 0
    },
    {
     "SpaceID": 262,
     "SpaceName": "Employee Onboarding",
     "NewContentCount": 0
    },
    {
     "SpaceID": 252,
     "SpaceName": "Human Resources",
     "NewContentCount": 2
    },
    {
     "SpaceID": 256,
     "SpaceName": "Information Technology",
     "NewContentCount": 1
    },
    {
     "SpaceID": 297,
     "SpaceName": "My Space",
     "NewContentCount": 0
    }
  ],
}

Please Note Your content type that you pass in the header of your request should be 'application/json'.

Wiki Index

Pages

Intranet Software