REST API: Get Content Analytics Count

Grace Kamau

Published: 5/27/2021

Bryce Johannes

Updated: 9/7/2023

0 (0votes)

Get Content Analytics Count

Get the number of views, likes, comments, ratings, or downloads. Valid for Communifire version 7.0 and above.

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.
Action	&Action=x - Used in the request URL as a query parameter	The ID of the activity action to get analytics for. Comment = 6 Download = 110 Like = 25 Rating = 28 View = 64

Optional Parameters	How to use	Description
SpaceID	&SpaceID=x - Used in the request URL as a query parameter	Specifies the space to get analytics for. The ID for the top level community is 0.
ContentTypeCSV	&ContentTypeCSV=x - Used in the request URL as a query parameter	Specifies the content types to return. See REST API: System Entity Types .
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.

Analytics count is returned as ResponseData.

{
  "IsError": false,
  "ResponseData": 1457
}

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