Get total record count of new homeowners

Request

This endpoint gets the total record count returned using the required and optional properties passed in. This endpoint does not count against the package usage.

Acceptstringrequired

Format of the response.

Enum:"application/json""*/*"

Example:application/json

Content-Typestringrequired

Format of the request.

Value:"application/json"

Bodyapplication/jsonrequired

CustomerIDstringrequired

The License Key issued by Melissa.

Includesobjectrequired

Any parameter you would like to include in the query.

Requires at least one from:

Zips
Cities
Radius
ShapeWKTs

Excludesobject

Any parameter you would like to exclude in the query.

ColumnsArray of strings

All NewHomeowners Columns you want returned.

Items Enum:"MelissaAddressKey""BaseMelissaAddressKey""FirstName""LastName""AddressLine""City""State""ZIPCode""Plus4""DeliveryPoint"

curl -i -X POST \
  https://dataretriever.melissadata.net/web/V1/NewHomeowners/doCount \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "CustomerID": "{REPLACE-WITH-YOUR-LICENSE-KEY}",
    "Includes": {
      "Zips": [
        {
          "Zip": "92688"
        }
      ],
      "SellDate": {
        "StartDate": "2023-01-01",
        "EndDate": "2024-01-01"
      }
    }
  }'

Responses

Successful response

Bodyapplication/json

Countinteger

Number of records returned by the query.

JobIdstring

The JobId to be used to purchase and access the full dataset.

ResultCodestring

Success or Error codes based on the response/request.

Messagestring

Success or Error message associated with the result code.

Response

{
  "Count": 406,
  "JobId": "returned_job_id",
  "ResultCode": "LS01",
  "Message": "Success - Results found"
}