getAllPageViews
Returns website visits (page views) for an account. Results are restricted to the last 3 months. Filter and page results as needed.
Input parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
|
FromDate |
date - ISO / UTC |
No |
The start date. |
|
ToDate |
date - ISO / UTC |
No |
The end date. |
|
NextPage |
string |
No |
Tells the server the next page of data to retrieve. This parameter should be the same value as what was returned in the response field "NextPage" by the previous call. |
Request format
curl "https://api.boldchat.com/aid/$accountID/data/rest/json/v1/getAllPageViews?auth=$authHash&FromDate=2020-01-01T00:00:00Z"Return values
Parameters are provided in alphabetic order. See Sample code for probable output.
| Parameter | Type | Description |
|---|---|---|
| AccountID | numeric - ID code | Bold360 product account ID. |
| Created | date - ISO/UTC | Date and time when the target resource was created. |
| Data | text - heading | JSON array heading that precedes report data output. |
| Ended | date - ISO/UTC | Date and time visit or chat ended. |
| PageViewID | numeric - ID code | A numeric identifier for a specific page view. |
| Status | codes - set values | "Success" when the call completes; "Error" when the call fails. |
| Truncated | Boolean | TRUE if results were shortened to fit the report, FALSE if full results for the report criteria were returned. If TRUE, you can filter down the results set or contact us to try to find a way to get at the data you are looking for. |
| Url | string - legal URL | The URL related to this resource. |
| VisitID | numeric - ID code | The identifier of a specific visit. |
| VisitorID | numeric - ID code | ID of the visitor / customer to whom this visit belongs. |
Sample code
{
"Status": "success",
"Truncated": false,
"Data": [
{
"VisitorID": "445562450089778948",
"AccountID": "447307299957849894",
"Ended": "2020-11-18T21:30:32.000Z",
"PageViewID": "445563557919057624",
"VisitID": "445563557341851705",
"Url": "https://bartolomeo.github.io/testpage/",
"Created": "2020-11-18T21:30:02.097Z"
},
]
}