API Analytic
Reads a summary of analytics.
Authentication: Windows
Privilege : Administrator , Power User , Moderator
Method: PxStat.Security.Analytic_API.Read
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
DateFrom |
Date ('YYYY-MM-DD') | Start of the date range for Read | |
DateTo |
Date ('YYYY-MM-DD') | End of the date range for Read | |
SbjCode |
Integer | 0 | Subject Code - optional |
PrcCode |
Integer | 0 | Product Code - optional |
NltInternalNetworkMask |
Boolean | false | To exclude internal access events - optional |
ExcludeInternal |
Boolean | false | To exclude internal access events - optional |
Return: Array [ Object ]
| Name | Type | Description |
|---|---|---|
PublishDate |
Date | Start of the date range for Read |
MtrCode |
Integer | Matrix Code |
MtrTitle |
String | Matrix title |
PrcCode |
Integer | Product Code |
PrcValue |
String | Product value |
SbjCode |
Integer | Subject Code |
SbjValue |
String | Subject Value |
NltBot |
Integer | Counts |
NltM2m |
Integer | Counts |
NltUser |
Table | Security_Analytic_InternalNetworks - User Defined Yype |
Total |
Integer | Counts |
Reads an analytic report based on Browser.
Authentication: Windows
Privilege : Administrator , Power User , Moderator
Method: PxStat.Security.Analytic_API.ReadBrowser
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
DateFrom |
Date ('YYYY-MM-DD') | Start of the date range for Read | |
DateTo |
Date ('YYYY-MM-DD') | End of the date range for Read | |
SbjCode |
Integer | 0 | Subject Code - optional |
PrcCode |
Integer | 0 | Product Code - optional |
NltInternalNetworkMask |
Boolean | false | To exclude internal access events - optional |
ExcludeInternal |
Boolean | false | To exclude internal access events - optional |
LngIsoCode |
String | Language to read returned data - optional |
Return: Array [ Object ]
| Name | Type | Description |
|---|---|---|
Browser |
String | Browser name |
NltCount |
Int | Number of calls by each browser |
Reads an analytic report based on Dates.
Authentication: Windows
Privilege : Administrator , Power User , Moderator
Method: PxStat.Security.Analytic_API.ReadTimeline
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
DateFrom |
Date ('YYYY-MM-DD') | Start of the date range for Read | |
DateTo |
Date ('YYYY-MM-DD') | End of the date range for Read | |
MtrCode |
Integer | Matrix Code - optional | |
LngIsoCode |
Integer | Matrix Code - optional | |
SbjCode |
Integer | Subject Code - optional | |
PrcCode |
Integer | Product Code - optional | |
ExcludeInternal |
Boolean | false | To exclude internal access events - optional |
LngIsoCode |
String | Language to read returned data - optional |
Return: Array [ Object ]
| Name | Type | Description |
|---|---|---|
Date |
Date | Date of entry |
NltBot |
Integer | Number of actions by bot |
NltUser |
Integer | Number of actions by users |
NltM2m |
Integer | Number of Machine to Machine calls |
Total |
Integer | total number of calls |
Read an analytic report based on Operating System.
Authentication: Windows
Privilege : Administrator , Power User , Moderator
Method: PxStat.Security.Analytic_API.ReadOs
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
DateFrom |
Date ('YYYY-MM-DD') | Start of the date range for Read | |
DateTo |
Date ('YYYY-MM-DD') | End of the date range for Read | |
SbjCode |
Integer | Subject Code - optional | |
PrcCode |
Integer | Product Code - optional | |
MtrCode |
Integer | null | Matrix Code - optional |
NltInternalNetworkMask |
Boolean | false | To exclude internal access events - optional |
ExcludeInternal |
Boolean | false | To exclude internal access events - optional |
LngIsoCode |
String | Language to read returned data - optional |
Return: Array [ Object ]
| Name | Type | Description |
|---|---|---|
Os |
String | Operating System |
NltCount |
Int | Count of entries using the Os |
Reads an analytic report based on Referrers.
Authentication: Windows
Privilege : Administrator , Power User , Moderator
Method: PxStat.Security.Analytic_API.ReadReferrer
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
DateFrom |
Date ('YYYY-MM-DD') | Start of the date range for Read | |
DateTo |
Date ('YYYY-MM-DD') | End of the date range for Read | |
SbjCode |
Integer | Subject Code - optional | |
PrcCode |
Integer | Product Code - optional | |
NltInternalNetworkMask |
Boolean | false | To exclude internal access events - optional |
MtrCode |
Integer | Matrix Code - optional | |
ExcludeInternal |
Boolean | false | To exclude internal access events - optional |
LngIsoCode |
String | Language to read returned data - optional |
Return: Array [ Object ]
| Name | Type | Description |
|---|---|---|
url |
String | Url of Referrer |
NltCount |
Int | Count of entries for this url |
Reads an analytic report based on Language.
Authentication: Windows
Privilege : Administrator , Power User , Moderator
Method: PxStat.Security.Analytic_API.ReadLanguage
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
DateFrom |
Date ('YYYY-MM-DD') | Start of the date range for Read | |
DateTo |
Date ('YYYY-MM-DD') | End of the date range for Read | |
LngIsoCode |
Integer | Default Language ISO Code | Language ISO Code - optional |
NltInternalNetworkMask |
Boolean | false | To exclude internal access events - optional |
MtrCode |
Integer | Matrix Code - optional | |
ExcludeInternal |
Boolean | false | To exclude internal access events - optional |
Return: Array [ Object ]
| Name | Type | Description |
|---|---|---|
LngIsoName |
String | Language ISO Name |
LngCount |
Date | Count of analytics for the chosen language |
Reads an analytic report based on Formats.
Authentication: Windows
Privilege : Administrator , Power User , Moderator
Method: PxStat.Security.Analytic_API.ReadFormat
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
DateFrom |
Date ('YYYY-MM-DD') | Start of the date range for Read | |
DateTo |
Date ('YYYY-MM-DD') | End of the date range for Read | |
SbjCode |
Integer | Subject Code - optional | |
PrcCode |
Integer | Product Code - optional | |
MtrCode |
Integer | null | Matrix Code - optional |
NltInternalNetworkMask |
Boolean | false | To exclude internal access events - optional |
ExcludeInternal |
Boolean | false | To exclude internal access events - optional |
Return: Array [ Object ]
| Name | Type | Description |
|---|---|---|
Format |
String | Format type plus version |
NltCount |
Int | Count of entries using the Format type/version combination |
Reads an analytic report based on the language environment of the API user.
Authentication: Windows
Privilege : Administrator , Power User , Moderator
Method: PxStat.Security.Analytic_API.ReadEnvironmentLanguage
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
DateFrom |
Date ('YYYY-MM-DD') | Start of the date range for Read | |
DateTo |
Date ('YYYY-MM-DD') | End of the date range for Read | |
SbjCode |
Integer | Subject Code - optional | |
PrcCode |
Integer | Product Code - optional | |
NltInternalNetworkMask |
Boolean | false | To exclude internal access events - optional |
MtrCode |
Integer | Matrix Code - optional | |
ExcludeInternal |
Boolean | false | To exclude internal access events - optional |
LngIsoCode |
String | Language to read returned data - optional |
Return: Array [ Object ]
| Name | Type | Description |
|---|---|---|
LngIsoCode |
String | LngIsoCode of user |
LngCount |
Int | Count of entries for this language |
