Skip to content
  • Consumer

    Use Consumer endpoints to retrieve information on consumers such as record counts, details, and other relevant data.

    Get total record count of consumers

    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.

    Headers
    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.

    POST
    /Consumer/doCount
    curl -i -X POST \
      https://dataretriever.melissadata.net/web/V1/Consumer/doCount \
      -H 'Accept: application/json' \
      -H 'Content-Type: application/json' \
      -d '{
        "CustomerID": "{REPLACE-WITH-YOUR-LICENSE-KEY}",
        "Includes": {
          "Zips": [
            {
              "Zip": "92688",
              "CarrierRoute": "C057"
            }
          ]
        },
        "Excludes": {
          "AddressStreetName": [
            {
              "ZipCode": "92688",
              "Street": "Arado"
            }
          ]
        }
      }'

    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": 606, "JobId": "returned_job_id", "ResultCode": "LS01", "Message": "Success - Results found" }