The Estimates API will provide a JSON response containing estimates of many records will be returned based on the request configuration and filter parameters.
This API is useful and recommended to be used before the Job Creation API so that the user can have an idea on how bit the returned list will me. The Estimates API can be called as many times as requested without incurring in any charge.
Tip: you may use the returned number of estimated records as the max records that the Job API will need to return. In this way you will obtain a list with the same number of records as the one obtained from the estimated value.
Format
Estimates API end point URL: https://api.versium.com/v2/b2cListGen/estimate
Http method: GET
This API uses the Configuration Parameters and Demographic Filter Parameters
Example: return the estimates for a list with attributes Fist name, last name, postal address, email for the geographical area of zip codes 98052, 98033 and 98034
https://api.versium.com/v2/b2cListGen/estimate?requirered_fields[]=address&required_fields[]=email&d_zip[]=98052&d_zip[]=98033&d_zip[]=98034
Response Structure
Content-type: application/json
The estimates API will return the estimates record count, the estimates records available, the estimates match credits and a preview sample of the data that will be returned.
{
"versium": {
"version": "2.0",
"query_id": "18f95f7b8415c0bbf5e42e3eba61b304",
"query_time": 0.3372931480407715,
"results": {
"estimated_record_count": 20121,
"estimated_records_available": 20121,
"estimated_match_credits": 20121,
"estimated_time": "1-2 Minutes",
"estimated_time_in_seconds": 120,
"preview": [
[
"First Name",
"Last Name",
"Email Address"
],
[
"Mayank",
"K******",
"m******@gmail.com"
],
[
"Lindsay",
"B***",
"l******@yahoo.com"
],
[
"Rishi",
"A******",
"i******@gmail.com"
],
[
"Delfina",
"A******",
"d******@gmail.com"
],
[
"Robin",
"S******",
"r******@aol.com"
],
[
"Angel",
"R***",
"a******@hotmail.com"
],
[
"Rhidian",
"L*******",
"r******@yahoo.com"
],
[
"Doan",
"N*****",
"d******@gmail.com"
],
[
"Tish",
"M******",
"t******@gmail.com"
]
]
}
}
}