Getting Started with Cloud Data Profiling REST API

Back Next

Run details of a profile

You can use the

topNrun

API call to identify the profile runs that consume the largest amount of storage space.

GET request: Use the GET method to identify the profile runs that consume the largest amount of storage space.; The following table lists the parameters to specify:

Property
Value

URL
Enter a URL to identify the profile runs that consume the largest amount of storage space. Use the following format: https://[HostName]/profiling-service/api/v1/runDetail/topNrun?limit=n

IDS-SESSION-ID
REST API session ID for the current session. Use in most REST API request headers. For example,
klCIHW6BvWmeFFwlQg7q84
API parameters: The following table lists the important query parameters exposed for this API:

Property
Value

Limit
Enter an integer value to limit the number of profile runs that the call identifies. The call identifies ten profile runs if you do not enter an integer value.
API response code: 200 OK

Property	Value
URL	Enter a URL to identify the profile runs that consume the largest amount of storage space. Use the following format: https://[HostName]/profiling-service/api/v1/runDetail/topNrun?limit=n
IDS-SESSION-ID	REST API session ID for the current session. Use in most REST API request headers. For example, klCIHW6BvWmeFFwlQg7q84

Property	Value
Limit	Enter an integer value to limit the number of profile runs that the call identifies. The call identifies ten profile runs if you do not enter an integer value.

API response: The total cost is less than 10 KB if the totalCostInMB
value is 0.00 MB. The minimum value in totalCostInMB is 0.01 MB or 10 KB.
{ "profileId": "605192fd-048a-443a-876f-47bb1edff07b", "runDetailId": "19c0a14d-ae39-402e-a9ee-d1d1b3c70bc0", "runKey": 1, "runCostInMB": "4.25", "createdTime": "2022-04-21 06:59:26.824", "startTime": "2022-04-21 06:59:26.86", "endTime": "2022-04-21 07:01:43.286", "profileName": "check profile name top N profile runs", "projectName": "Story CP-8099", "folderName": "topNprofilingtasks" }

Watch

Comments