REST API: Get Space Analytics

Anonymous User

Published: 6/21/2019

Grace Kamau

Updated: 8/31/2020

0 (0votes)

Get Space Analytics

Allows a member to get space analytics. Valid for Communifire version 6.0 and above.

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.
SpaceID	Used in the request URL (see below)	Unique ID for a Space.

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/297/analytics?from=01/06/2019&to=22/06/2019


{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": {
    "SpaceID": 297,
    "SpaceName": "My Space",
    "NewContentCount": 1
   }
}

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