Enterprise Data Catalog REST API Reference > Analytics APIs > Analytics REST APIs
  

Analytics REST APIs

You can use the following Analytics REST APIs to list the data from charts and hero stats in Data Asset Analytics:
Analytics REST API
Description
POST getChartData
Returns the Dashboard Data from charts.
POST getHeroStatsData
Returns the Dashboard Data from hero stats.

List Chart Data

getChartData
API to list all the chart data from Data Asset Analytics.
REST API Element
Input Format
Request URL
<DataAssetAnalytics>:<port>/analytics/v1/getChartData
HTTP Method Type
POST

Request Parameters

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:
Chart
Filter
Active User Growth
USER_GROUP_NAME
User Searches
USER_GROUP_NAME
Data Assets with Lineage and Impact
ASSET_GROUP
Assets with Enrichment
  • - ASSET_GROUP
  • - ENRICH_TYPE
Asset Growth
RESOURCE_NAME
Asset Changes
RESOURCE_NAME
Body
Model
chartName
Required
The name of the chart from which the data must be listed. Provide one of the following values:
  • - UserLogins
  • - ActiveUserGrowth
  • - UserSearches
  • - TopAssetsViewed
  • - ResourceGrowth
  • - AssetGrowth
  • - Top15ResourceTypes
  • - AssetChanges
  • - AssociatedBusinessTerms
  • - AssetsWithLineageAndImpact
  • - AssetsWithEnrichment
  • - DegreeOfCollaborationAcrossResources
  • - TopCollaborators
  • - CollaborationActivity
  • - TopAssetsWithCollaboration
  • - AssetEnrichmentValue
  • - FeatureUsageValue
  • - CollaborationValue
  • - ResourceValue
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

Response Codes

Code
Reason
200
List the chart data
400
Missing or invalid parameter
401
Missing credentials
404
Chart not found
500
Internal server error

Sample Call Using Curl

curl -X POST "http://<DataAssetAnalytics>:<port>/analytics/v1/getChartData?chartName=TopAssetsViewed&fromDate=04%2F10%2F2020&toDate=01%2F01%2F2021" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"additionalProp1\": \"string\", \"additionalProp2\": \"string\", \"additionalProp3\": \"string\"}"

List Hero Stats Data

getHeroStatsData
API to list all the hero stats data from Data Asset Analytics.
REST API Element
Input Format
Request URL
<DataAssetAnalytics>:<port>/analytics/v1/getHeroStatsData
HTTP Method Type
POST

Request Parameters

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

Response Codes

Code
Reason
200
List the hero stats data
400
Missing or invalid parameter
401
Missing credentials
500
Internal server error

Sample Call Using Curl

curl -X POST "http://<DataAssetAnalytics>:<port>/analytics/v1/getHeroStatsData?fromDate=04%2F10%2F2020&toDate=01%2F01%2F2021" -H "accept: application/json"