Dataphin:View details of an API asset

Prerequisites

You must have purchased the asset operation value-added service and the DataService Studio feature.

API asset details

1. In the top menu bar on the Dataphin home page, select Asset > Asset Directory.

2. Select the API asset tab, then click the name of the target asset to access the asset details page.

   

   Area	Description
   ①Summary Information	Displays the API's name, API_ID, type, description, and tag information. Additionally, you can perform the following operations on the asset: View Metadata: Click to jump to the asset checklist details page for this API. Search Asset: Supports quick search for other objects. Select the asset you want to view and jump to the API details page. Favorite: Click to add to or remove from favorites. After adding to favorites, you can also view all favorited assets in the Personal Data Center. For more information, see View and manage my favorited assets. Download API Document: Click to download the API document in Word format for business personnel to modify. Request Permission: Click to quickly jump to the permission request page for the current API. For more information, see Manage API permissions. Edit: Click Edit to jump to the directory management page for editing the current API asset. You can modify the asset's property information and usage instructions. For more information, see Edit asset information. View Invocation Instructions: Click to view the API invocation example template, including Java SDK invocation method (including Python SDK invocation flow), Token invocation method, whitelist invocation method. Note If the SDK and invocation instructions are modified in Service > Invoke > Invocation Instructions, the invocation instructions here will be synced. Therefore, there may be differences between the help document and the actual situation. Default Invocation Example Download: Click to download the API invocation example. Python Invocation Example Download: Click to download the Python example file package. Java SDK Download: Click to download the Java SDK code package.
   ②Basic Information	Property Information: Displays the API's property information, including technical properties. Technical properties: Displays information such as the asset source, API group, and data update frequency of the API. You can view the technical properties for the corresponding API type on the asset details page. Data Update Frequency: The data source update frequency of the current API, which helps the caller understand the data's timeliness. Custom Properties: Displays the properties created in Data Warehouse Plan > Attribute Management that are visible in the asset directory. Custom properties belong to business properties, management properties, and technical properties. API Document: You can view the API's basic information, business request parameter list, public request parameter list, return parameter list, JSON return example, row-level permission list (displayed only when row-level permissions are enabled when creating the API) along with client error codes, server error codes (invoking API), and server error codes (executing SQL statement). Usage Instructions: The usage instructions need to be enabled on the manually listed API asset editing page. Displays the current asset's usage instructions, providing information reference for data viewers and users.
   ③Asset Information	Displays the API's Usage Statistics and Basic Information and other detailed information. Usage Statistics: Includes the API's page views, number of favorites, and number of invocations in the last 7 days. Page Views: Displays the current API's page views (PV). Each refresh increases by one, updated in real-time. Only includes page views of the asset directory details page. Number Of Favorites: Displays the number of times the current API has been favorited by users, including favorites in the asset checklist and asset directory, updated in real-time. Number Of Invocations In The Last 7 Days: Displays the number of times the current API has been invoked in the last 7 days, updated in real-time. Basic Information: Includes the initial listing time, most recent listing time, publisher, and belonging directory.