Analytics REST API | Description |
---|---|
POST getChartData | Returns the Dashboard Data from charts. |
POST getHeroStatsData | Returns the Dashboard Data from hero stats. |
REST API Element | Input Format |
---|---|
Request URL | <DataAssetAnalytics>:<port>/analytics/v1/getChartData |
HTTP Method Type | POST |
Parameter | Required or Optional | Description | Parameter Type | Data Type | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
chartFilter | Optional | Provide the list of filters that you want to apply to the chart in the following format: { "filter1": "value", "filter2": "value" } You can apply the following filters to the charts:
| Body | Model | ||||||||||||||
chartName | Required | The name of the chart from which the data must be listed. Provide one of the following values:
| Query | String | ||||||||||||||
fromDate | Required | Specify the start date for the time range for which you want to view the chart data. Enter the date in MM/DD/YYYY format. | Query | String | ||||||||||||||
toDate | Required | Specify the end date for the time range for which you want to view the chart data. Enter the date in MM/DD/YYYY format. | Query | String |
Code | Reason |
---|---|
200 | List the chart data |
400 | Missing or invalid parameter |
401 | Missing credentials |
404 | Chart not found |
500 | Internal server error |
REST API Element | Input Format |
---|---|
Request URL | <DataAssetAnalytics>:<port>/analytics/v1/getHeroStatsData |
HTTP Method Type | POST |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
fromDate | Required | Specify the start date for the time range for which you want to view the hero stats. Enter the date in MM/DD/YYYY format. | Query | String |
toDate | Required | Specify the end date for the time range for which you want to view the hero stats. Enter the date in MM/DD/YYYY format. | Query | String |
Code | Reason |
---|---|
200 | List the hero stats data |
400 | Missing or invalid parameter |
401 | Missing credentials |
500 | Internal server error |