REST API: Get Unique Visitors Count

Grace Kamau

Published: 5/27/2021

Bryce Johannes

Updated: 9/7/2023

0 (0votes)

Get Unique Visitors Count

Get the number of unique people who have visited your site. 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.

Optional Parameters	How to use	Description
SpaceID	&SpaceID=x - Used in the request URL as a query parameter	Specifies the space to get unique visitor count for. The ID for the top level community is 0.
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.

User count is returned as ResponseData.

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

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