getAllPageViews

Retrieves page views across the account based on the Ended date. Results are restricted to the last 3 months.

Important: As of March 31, 2018, version 1 of the getAllPageViews method becomes deprecated. From April 1, 2018, this API call returns an HTTP 410 error message. Use version 2 of getAllPageViews to retrieve page views.

Gets page views across the account based on the Ended date. Results are restricted to the last 3 months.
No additional parameters are needed.
Max page size: 1000 records

Input parameters

Parameter	Type	Version	Required	Description
FromDate	date	All	no	The start date.
ToDate	date	All	no	The end date.
PageStart	integer	v1	no	The number of elements to skip in the result set.
PageSize	integer	v1	no	The number of results in the returned set. This can be used to limit the returned set to less than the server maximum (this will not allow you to exceed the server page size, which is 1000 records in most cases.)

Return values

Parameter	Type	Version	Description
Data	json array	All	A JSON array of JSON objects with the mappings of fields to values.
Truncated	boolean	All	Whether or not the above JSON array is the complete result set, or if the server limited the returned results.
Next	json object	v1	If the method called supports it, and the data is truncated, the Next parameter will contain the necessary parameters to pass back to the same server method to get more results.

Additional information

Maximum page size: 1000 records

Sample code

curl "https://api.boldchat.com/aid/$accountId/data/rest/json/v1/getAllPageViews?FromDate=2017-11-02T07:50:41+01:00&PageSize=500"

This API call returns the following result:

{
   "Status":"success",
   "Truncated":true,
   "Next":{
      "PageSize":500,
      "PageStart":1,
      "FromDate":"2017-11-02T06:50:41.000Z",
      "ToDate":"2018-01-23T13:43:56.000Z"
       },
   "Data":[...]
}

As long as the Truncated parameter is returned as true, you can query the next page of the results as follows:

curl "https://api.boldchat.com/aid/$accountId/data/rest/json/v1/getAllPageViews?FromDate=2017-11-02T07:50:41+01:00&ToDate=2018-01-23T14:43:56+01:00&PageStart=1&PageSize=500"

This API call returns the following result:

{
   "Status":"success",
   "Truncated":false,
   "Data":[...]
}