Communities
A collaborative platform to connect and grow with like-minded Informaticans across the globe
Product Communities
Connect and collaborate with Informatica experts and champions
Discussions
Have a question? Start a Discussion and get immediate answers you are looking for
User Groups
Customer-organized groups that meet online and in-person. Join today to network, share ideas, and get tips on how to get the most out of Informatica
Get Started
Community Guidelines
Knowledge Center
Troubleshooting documents, product guides, how to videos, best practices, and more
Knowledge Base
One-stop self-service portal for solutions, FAQs, Whitepapers, How Tos, Videos, and more
Support TV
Video channel for step-by-step instructions to use our products, best practices, troubleshooting tips, and much more
Documentation
Information library of the latest product documents
Velocity (Best Practices)
Best practices and use cases from the Implementation team
Learn
Rich resources to help you leverage full capabilities of our products
Trainings
Role-based training programs for the best ROI
Certifications
Get certified on Informatica products. Free, Foundation, or Professional
Product Learning Paths
Free and unlimited modules based on your expertise level and journey
Resources
Library of content to help you leverage the best of Informatica products
Tech Tuesdays Webinars
Most popular webinars on product architecture, best practices, and more
Product Availability Matrix
Product Availability Matrix statements of Informatica products
SupportFlash
Monthly support newsletter
Support Documents
Informatica Support Guide and Statements, Quick Start Guides, and Cloud Product Description Schedule
Product Lifecycle
End of Life statements of Informatica products
Ideas
Events
Change Request Tracking
Marketplace
English
  • Data Profiling H2L
  • All Products

Table of Contents

Search

  1. Abstract
  2. Supported Versions
  3. Getting Started with Cloud Data Profiling REST API

Getting Started with Cloud Data Profiling REST API

Getting Started with Cloud Data Profiling REST API

Back Next

View profile results

View profile results

After you run a profile on a source object, the results include the column statistics, such as Number of distinct, non-distinct, and null values, Percentage of distinct, non-distinct, null, zero, and blank values, Documented and inferred data types, and Number of patterns.
In this tutorial, you can view all the profiled columns and view the results of a column.

List all columns

Displays all the columns and rules and their statistics in the profile run.
GET request
Use the GET method to list all columns in a profile.
The following table lists the parameters that you need to specify to view all columns in the profile run:
Property
Value
URL
Enter a URL to view all columns in the profile run. Use the following format: https://usw3-dqprofile.dm-us.informaticacloud.com/metric-store/api/v1/odata/Profiles('profileId')/Columns
API parameters
The following table lists the important query parameters exposed for this API:
Property
Value
profileId
The unique identifier of the Data Profiling asset. For example, 908ed64e-cfd0-4544-bb69-5f5414e2f18b
To retrieve the ProfileId, see the Prerequisites section.
API response code
200 OK
API response 

{
"@odata.context":
"$metadata#Columns"
"value":[
0:{
"columnKey":
10001
"runKey":
1
"columnName":
"NATIONALCHARACTER_COL"
"columnId":
"2d5e1e62-64ab-4385-a0e0-00801b163996"
"columnType":
"DATASOURCEFIELD"
"averageValue":
NULL
"minimumValue":
"o"
"maximumValue":
"u"
"maximumLength":
1
"minimumLength":
1
"standardDeviation":
NULL
"nulCount":
47
"nulPercent":
83.93
"zeroCount":
0
"zeroPercent":
0
"blankCount":
0
"blankPercent":
0
"totalRows":
56
"totalSum":
NULL
"distinctCount":
3
"distinctPercent":
5.36
"duplicateCount":
6
"duplicatePercent":
10.71
"documentedDataType":
"nchar(2)"
"totalPatterns":
2
"topPatternPercent":
83.93
"isConflictingInfDocumentDataType":
false
"containLineFeeds":
false
"containLeadTrailSpaces":
false
"isValueFreqOutlier":
false
"isPatternOutlier":
false
"profileKey":
562
"order":
15
}
1:{
...
}
2:{
...
}
]
}

Get Column By ID

Displays the detailed profile results for a column. In this tutorial, you can view the column details of the
CountryName
 column.
GET request
Use the GET method to view detailed column profile results.
The following table lists the parameters that you need to specify to view detailed column profile results:
Property
Value
URL
Enter a URL to view column profile results. Use the following format: https://usw3-dqprofile.dm-us.informaticacloud.com/metric-store/api/v1/odata/Profiles('profileId')/Columns('columnId')
API parameters
The following table lists the important query parameters exposed for this API:
Property
Value
profileID
The unique identifier of the Data Profiling asset. For example, 908ed64e-cfd0-4544-bb69-5f5414e2f18b
To retrieve the ProfileId, see the Prerequisites section.
ColumnID
The unique identifier of the column in the Data Profiling asset. For example, c5c51e8d-14b9-4d0d-a956-b643c72cd87b
Copy the column ID from the list all columns API response.
runKey
Indicates the run key of the profile run.
Select 1.
API response code
200 OK
API response 

{
"@odata.context":
"$metadata#Columns"
"columnKey":
10038
"profileKey":
514
"runKey":
1
"columnName":
"CountryName"
"columnId":
"c5c51e8d-14b9-4d0d-a956-b643c72cd87b"
"columnType":
"DATASOURCEFIELD"
"averageValue":
NULL
"minimumValue":
"CA"
"maximumValue":
"UNITED KINGDOM "
"maximumLength":
48
"minimumLength":
2
"standardDeviation":
NULL
"nulCount":
1
"nulPercent":
2.17
"zeroCount":
0
"zeroPercent":
0
"blankCount":
0
"blankPercent":
0
"totalRows":
46
"totalSum":
NULL
"distinctCount":
17
"distinctPercent":
36.96
"duplicateCount":
28
"duplicatePercent":
60.87
"documentedDataType":
"flat_string(255)"
"totalPatterns":
7
"topPatternPercent":
30.43
"isConflictingInfDocumentDataType":
false
"containLineFeeds":
false
"containLeadTrailSpaces":
false
"isValueFreqOutlier":
true
"isPatternOutlier":
true
"order":
41
}

Get inferred patterns by column ID

Displays inferred patterns and their frequency and percentage for each column.
GET request
Use the GET method to view the inferred patterns for the column
The following table lists the parameters that you need to specify to view the inferred patterns for the column:
Property
Value
URL
Enter a URL to view the inferred patterns for the column. Use the following format: https://usw3-dqprofile.dm-us.informaticacloud.com/metric-store/api/v1/odata/Profiles('profileId')/Columns('columnId')/Patterns
API parameters
The following table lists the important query parameters exposed for this API:
Property
Value
profileID
The unique identifier of the Data Profiling asset. For example, 908ed64e-cfd0-4544-bb69-5f5414e2f18b
To retrieve the ProfileId, see the Prerequisites section.
ColumnID
The unique identifier of the column in the Data Profiling asset. For example, c5c51e8d-14b9-4d0d-a956-b643c72cd87b
Copy the column ID from the list all columns API response.
API response code
200 OK
API response 

{
"@odata.context":
"$metadata#Patterns"
"value":[
0:{
"domainType":
"Pattern"
"profileKey":
3277
"runKey":
1
"nullCount":
3
"nullPercent":
5.36
"totalRows":
56
"isConflictingInfDocumentDataType":
false
"columnKey":
10001
"domainValue":
"XXXX"
"inferredDatatype":
"String(11) [100.00%]"
"satisfiedCount":
3
"satisfiedCountPercent":
5.36
"rowIdentifier":
0
"domainName":
NULL
"patternLabel":
"X(4)"
"isOutlier":
NULL
}
1:{
...
}
2:{
...
}
3:{
...
}
4:{
...
}
]
}

Get Inferred Datatypes by Column ID

Displays the inferred data type.
GET request
Use the GET method to view the inferred data types for the columns.
The following table lists the parameters that you need to specify to view the inferred datatypes for the column:
Property
Value
URL
Enter a URL to view the inferred datatypes for the column. Use the following format: https://usw3-dqprofile.dm-us.informaticacloud.com/metric-store/api/v1/odata/Profiles('profileId')/Columns('columnId')/DataTypes
API parameters
The following table lists the important query parameters exposed for this API:
Property
Value
profileID
The unique identifier of the Data Profiling asset. For example, 908ed64e-cfd0-4544-bb69-5f5414e2f18b
To retrieve the ProfileId, see the Prerequisites section.
ColumnID
The unique identifier of the column in the Data Profiling asset. For example, c5c51e8d-14b9-4d0d-a956-b643c72cd87b
Copy the column ID from the list all columns API response.
API response code
200 OK
API response 

{
"@odata.context":"$metadata#DataTypes"
"value":[
0:{
"columnKey":10001
"profileKey":3221
"runKey":1
"totalRows":56
"inferredDatatype":"String(11)"
"frequency":53
"frequencyPercent":100
"rowIdentifier":0
"isCommittedDatatype":true
"format":NULL
}
]
}

Get Top N value frequencies by column ID

Displays the value frequency of the column.
GET request
Use the GET method to view the value frequency of the columns.
The following table lists the parameters that you need to specify to view the value frequency of the column:
Property
Value
URL
Enter a URL to view the value frequency of the column. Use the following format: https://usw3-dqprofile.dm-us.informaticacloud.com /metric-store/api/v1/odata/Profiles('profileId')/Columns('columnId')/ValueFrequencies
API parameters
The following table lists the important query parameters exposed for this API:
Property
Value
profileID
The unique identifier of the Data Profiling asset. For example, 908ed64e-cfd0-4544-bb69-5f5414e2f18b
To retrieve the ProfileId, see the Prerequisites section.
ColumnID
The unique identifier of the column in the Data Profiling asset. For example, c5c51e8d-14b9-4d0d-a956-b643c72cd87b
Copy the column ID from the list all columns API response.
API response code
200 OK
API response 

{
"@odata.context":
"$metadata#ValueFrequencies"
"value":[
0:{
"frequency":
3
"columnValue":
NULL
"rowIdentifier":
0
"isOutlier":
true
"percent":
5.35714
"length":
NULL
}
1:{
"frequency":
3
"columnValue":
NULL
"rowIdentifier":
0
"isOutlier":
true
"percent":
5.35714
"length":
NULL
}
2:{
...
}
3:{
...
}
]
}

Export profile results

Exports the profile results to a Microsoft Excel file.
GET request
Use the GET method to export the profile results.
The following table lists the parameters that you need to specify to export the profile results to a Microsoft Excel file:
Property
Value
URL
Enter a URL to export the profile results to a Microsoft Excel file. Use the following format: https://usw3-dqprofile.dm-us.informaticacloud.com/metric-store/api/v1/Profiles('{profileId}')/Export
API parameters
The following table lists the important query parameters exposed for this API:
Property
Value
profileID
The unique identifier of the Data Profiling asset. For example, 908ed64e-cfd0-4544-bb69-5f5414e2f18b
To retrieve the profileID, see the Prerequisites section.
runKey
Indicates the run key of the profile run.
Select 1.
range
Choose
All Columns
 to export the results for all the columns, or choose
Selected Columns
 and select one or more columns to export the results for the chosen columns.
fileFormat
By default, the fileFormat is set to
Excel
.
API response code
200 OK
0 COMMENTS
We’d like to hear from you!