ID Changelog

To read more about our persistent ID logic, please consult our Persistent IDs page.

version_status Field

Data license customers have an additional field appended to each data license profile: a version_status for the ID. This object tracks the previous 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 the three following 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

We also provide an additional changelog that includes all six statuses (with moved, opted_out and deleted records included) as a flat file in this public AWS bucket. Here is a description of each status:

Additional Metadata

Some of the statuses listed in the table above will also contain the following metadata:

Sample Changelogs

{
    "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",...]
    }
}