Loading ...

REST API: Get Search Analytics | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Analytics » REST API: Get Search Analytics
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 4

REST API: Get Search Analytics

0 
 /5
0 (0votes)

Get Search Analytics

GET api/searchqueries

Get a list of Search Analytics such as keywords, click counts and click-through rate for each keyword. 

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
8.0 and above | 20.0 and above for SearchTerm and Person parameters
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.
StartPage &StartPage=x - Used in the request URL (see below) Specifies the starting page of list to be returned.
PageLength &PageLength=x - Used in the request URL (see below) Specifies the number of results to be returned per page.
Optional Parameters How to use Description
SpaceID &SpaceID=x - Used in the request URL Unique ID of the space from which the content is to be returned.
Don't pass any value if you want content from every space, where you have access.
StartDate &startDate=x - Used in the request URL Start date of range to Search history. The date format is YYYY-MM-DD:HH:mm:ssZ. 
EndDate &endDate=x - Used in the request URL End date of range to Search history. The date format is YYYY-MM-DD:HH:mm:ssZ. 
SearchTerm &term=x - Used in the request URL Specifies the search term to display results. Note: Only available in version 20 and above.
Person &UserID=x - Used in the request URL User ID to return results for. Note: Only available in version 20 and above.

 

Example Request

GET https://myintranet.communifire.com/api/searchqueries?StartPage=1&PageLength=10

Example Response

Content JSON object is returned as ResponseData. 

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "SearchTerm": "a",
      "UserID": 0,
      "DateSearched": "0001-01-01T00:00:00",
      "SearchCount": 925,
      "ClickCount": 154,
      "ClickThroughRate": 0.16648648648648648,
      "TenantID": 0
    }
  ]
}

 

Example Request for searching with Search Term and Person

GET https://myintranet.communifire.com/api/searchqueries?StartPage=1&PageLength=10&term=alexis&userid=4

Example Response

Content JSON object is returned as ResponseData. 

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "SearchTerm": "Alexis",
      "UserID": 0,
      "DateSearched": "0001-01-01T00:00:00",
      "SearchCount": 1,
      "ClickCount": 0,
      "ClickThroughRate": 0,0
      "TenantID": 0
    }
  ]
}

 

 

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

 

Wiki Index

Pages

Intranet Software