Data Density API
The data density figure represents the percentage of records that have values for an attribute. For example, if only half the total number of records in the Address data object have a non-null value populated for the State attribute, then the data density value for State is 50%.
Use the data density API for the following use cases:
- Checking how many rows exist in a data object.
- Checking per data object attribute, how many are null/populated.
- Checking the density is per attribute, i.e. the percentage of records with the attribute populated.
Note: Data density is not applicable to complex data types such as arrays and maps.
Request Method | Service URL |
---|---|
|
/api-data/v1/{access-key}/data/density/entities/{tableId}
|
Request Headers |
|
Response Body Example
Returns statistics for a single data object.
{
"tableId": <tableId (tableId is PrimaryKey for table)>
"rowCount": <total rows in table>
"columns":[{
"fieldId":<fieldId of column (fieldId is SubKey for column)>
"notNullValueCount":<number of rows where this column value is not null>
"density":<0-100% of column value populated>
},
<more cols ...>
]
}