Statistics
To obtain details of matches for the various categories of checks made by Address Cleanse (address matches, de-duplications and suppressions), use the statistics method…
GET https://www.hopewiser.com/online-address-cleanse/api/v1/results/statistics?runId=49
Parameter:
Name |
Description |
Example Value |
runId |
ID returned by /run |
49 |
Body:
{
"recordCount": integer,
"codingStats": [
{
"name": string,
"description": string,
"count": integer
}
],
"addressUpdateStats": [
{
"name": string,
"description": string,
"count": integer
}
],
"dedupeStats": [
{
"name": string,
"description": string,
"count": integer
}
],
"suppressionRemovedStats": [
{
"name": string,
"description": string,
"typeName": string,
"typeDescription": string,
"count": integer
}
],
"suppressionFlaggedStats": [
{
"name": string,
"description": string,
"typeName": string,
"typeDescription": string,
"count": integer
}
],
}
Response:
{
"recordCount": 76,
"codingStats": [
{
"name": "Matched",
"description": "A correct address",
"count": 11
},
{
"name": "UnmatchedPremise",
"description": "The premise, e.g. house number, was not found",
"count": 1
},
{
"name": "UnmatchedStreet",
"description": "The thoroughfare, e.g. street, was not found",
"count": 1
},
{
"name": "UnmatchedTown",
"description": "The town was not found",
"count": 62
},
{
"name": "Unmatched",
"description": "No parts of the address could be verified",
"count": 1
}
],
"dedupeStats": [
{
"name": "Unique",
"description": "The record is unique",
"count": 98
},
{
"name": "Parent",
"description": "The first record that is a duplicate based on the level selected",
"count": 1
},
{
"name": "Child",
"description": "The record is a duplicate of a parent record",
"count": 1
}
],
"suppressionRemovedStats": [
{
"name": "Goneaway",
"description": "People who have moved",
"typeName": "DBS",
"typeDescription": "Purifi",
"count": 11
},
{
"name": "Goneaway",
"description": "People who have moved",
"typeName": "DCR",
"typeDescription": "DisConnect",
"count": 3
},
{
"name": "Goneaway",
"description": "People who have moved",
"typeName": "GAS",
"typeDescription": "Goneaway Suppression",
"count": 1
},
{
"name": "Goneaway",
"description": "People who have moved",
"typeName": "RMG",
"typeDescription": "Re-Movers",
"count": 7
},
{
"name": "Preference",
"description": "People listed on Mailing Preference Service",
"typeName": "MPS",
"typeDescription": "Mailing Preference Service",
"count": 1
}
],
"suppressionFlaggedStats": []
}
The name and description for the codingStats may be one of the following;
Name |
Description |
Matched |
A correct address |
UnmatchedPremise |
The premise, e.g. house number, was not found |
UnmatchedStreet |
The thoroughfare, e.g. street, was not found |
UnmatchedTown |
The town was not found |
Unmatched |
No parts of the address could be verified |
The name and description for the addressUpdateStats may be one of the following;
Name |
Description |
RecordCount |
The number of records where the address was updated |
PostcodeAdded |
The number of records where the postcode was not specified in the input but was added to the output |
PostcodeUpdated |
The number of records where the postcode was specified in the input but was updated in the output |
SubpremiseUpdated |
The number of records where the subpremise was either added or updated to the output |
HouseUpdated |
The number of records where the house was either added or updated to the output |
StreetUpdated |
The number of records where the street was either added or updated to the output |
DistrictUpdated |
The number of records where the district was either added or updated to the output |
Unknown |
Unknown |
The name and description for the dedupeStats may be one of the following;
Name |
Description |
Unique |
The record is unique |
Parent |
The first record that is a duplicate based on the level selected |
Child |
The record is a duplicate of a parent record |
The name, description, typeName and typeDescription for both the suppressionRemovedStats and suppressionFlaggedStats may be one of the following;
Name |
Description |
typeName |
typeDeccription |
Deceased |
People who have died |
MPS |
Mailing Preference Service |
Deceased |
People who have died |
MTS |
Mortascreen |
Deceased |
People who have died |
NDR |
National Deceased Register |
Deceased |
People who have died |
TBR |
Bereavement Register |
Goneaways |
People who have moved |
DBS |
Purifi |
Goneaways |
People who have moved |
GAS |
Goneaway Suppression |
Goneaways |
People who have moved |
RMG |
Re-movers |
Goneaways-Reconnect |
People who have moved, where a forwarding address is available |
DBS |
Purifi |
Goneaways-Reconnect |
People who have moved, where a forwarding address is available |
GAS |
Goneaway Suppression |
Goneaways-Reconnect |
People who have moved, where a forwarding address is available |
RMG |
Re-movers |
Preference Services |
People listed on Mailing Preference Service |
MPS |
Mailing Preference Service |