ID Changelog
To read more about our persistent ID logic please consult our Persistent IDs page.
version_status Field
Data license customers will have an additional field appended to each data license profile, a version_status
for the ID. This object will track the pervious and current dataset version, any other persistent IDs that were merged into this record using improved entity resolution, and the status of the record. Records still existing in the dataset can have one of three statuses added
, updated
, or unchanged
. Records can also have a null
version_status
if they are not in any of our license datasets.
ID Changelog
An additional changelog including all six statuses (moved
, opted_out
, and deleted
records included) will also be provided as a flat file in a public AWS bucket here. Example schemas are also provided:
Status | Frequency | Description |
---|---|---|
added | common | This record was not in a previous build |
deleted | very rare | This ID was removed due to a source-level removal |
moved | variable | Less common then added/updated, will vary from build to build based on linkage improvements |
opted_out | very rare | This ID was removed due to an opt out on our website. |
unchanged | common | No new data sources have been added to the record. However parsing/standardization improvements may have been made |
updated | common | A new data source contributed to this record |
Additional Metadata
Some of the statuses listed in the table above will also contain some additional metadata:
Metadata Field | Corresponding Version Status | Description |
---|---|---|
|
| The persistent IDs of any records that existed in a previous version and have been merged together before or during the current version. |
|
| The persistent ID that this record has been assigned in the current version. |
{
"previous_version": "14.0",
"current_version": "15.0",
"status": "added",
"additional_meta": None
}
{
"previous_version": "14.0",
"current_version": "15.0",
"status": "deleted",
"additional_meta": None
}
{
"previous_version": "14.0",
"current_version": "15.0",
"status": "moved",
"additional_meta": {
"to": "abcabc"
}
}
{
"previous_version": "14.0",
"current_version": "15.0",
"status": "opted_out",
"additional_meta": None
}
{
"previous_version": "14.0",
"current_version": "15.0",
"status": "unchanged",
"additional_meta": None
}
{
"previous_version": "14.0",
"current_version": "15.0",
"status": "updated",
"additional_meta": {
"contains": ["123123",...]
}
}
Updated about 2 months ago