# Get record count and sample of consumers

This endpoint allows API users to retrieve a count and 10 record sample of the results to preview before purchasing a file version of the full dataset.

Endpoint: POST /Consumer/getCount

## Request fields (application/json):

  - `CustomerID` (string, required)
    The [License Key](https://docs.melissa.com/melissa/license/license-information.html) issued by Melissa.

  - `Includes` (object, required)
    Any parameter you would like to include in the query.

Requires at least one from:
- Zips
- Cities
- Radius
- ShapeWKTs

  - `Includes.Zips` (array)
    A list of Zips objects containing Zip codes and optionally Plus4.

  - `Includes.Zips.Zip` (string, required)

  - `Includes.Zips.Plus4` (string)

  - `Includes.Cities` (array)
    A list of cities objects each containing City and State.

  - `Includes.Cities.City` (string, required)

  - `Includes.Cities.State` (string, required)

  - `Includes.Radius` (object)
    A Radius object containing a Latitude, Longitude, and Distance represented in miles.

  - `Includes.Radius.Latitude` (number, required)

  - `Includes.Radius.Longitude` (number, required)

  - `Includes.Radius.Distance` (number, required)

  - `Includes.ShapeWKTs` (array)
    A list of WKT polygon strings

  - `Includes.RBDI` (array)
    An RBDI code.

  - `Includes.FIPSCode` (array)
    A list of FIPSCodes.

  - `Includes.AddressStreetName` (array)
    A list of address street name objects.

  - `Includes.AddressStreetName.ZipCode` (string)

  - `Includes.AddressStreetName.Street` (string)

  - `Excludes` (object)
    Any parameter you would like to exclude in the query.

  - `Columns` (array, required)
    All [Consumer Columns](https://docs.melissa.com/reference-data/data-retriever/data-retriever-reference-guide.html#consumer-one) you want returned.
    Enum: "MelissaAddressKey", "BaseMelissaAddressKey", "TitlePrefixInd", "FirstName", "MiddleNameInitial", "LastName", "FullName", "NameSuffix", "AddressLine", "Suite", "City", "State", "ZIPCode", "Plus4", "DeliveryPoint", "AddressKey", "ResultCodes", "AddressStreetNumber", "AddressDirectionPrefix", "AddressStreetName", "AddressStreetSuffix", "AddressDirectionSuffix", "AddressSuiteName", "AddressSuiteNumber", "AddressTypeInd", "AddressType", "RBDI", "WalkSequencenumber", "CarrierRoute", "FIPSCode", "FIPSMCDCode", "PlaceCode", "Latitude", "Longitude", "CensusKey", "CBSACode", "OccupationCode1", "ApiderCode", "ContactAgeGroup", "BirthYear1", "BirthMonth1", "BirthDay1", "Apider1", "PoliticalPartyCode1", "EducationCode1", "PhoneNumber", "PhonePresenceInd", "Email", "EmailResultLevel", "eMailAppendAvailableInd", "AgeLessthan1Ind", "Age1Ind", "Age2Ind", "Age3Ind", "Age4Ind", "Age5Ind", "Age6Ind", "Age7Ind", "Age8Ind", "Age9Ind", "Age10Ind", "Age11Ind", "Age12Ind", "Age13Ind", "Age14Ind", "Age15Ind", "Age16Ind", "Age17Ind", "Age18Ind", "SupportsChildrensInd", "NumberOfChildrenCode", "PresenceOfChildrenInd", "NumberOfAdultsCode", "HouseholdSizeCode", "EstimatedHomeMarketValueCode", "HomeOwnerRenterCode", "IncomeEstimatedHousehold", "HouseholdAgeCode", "Age0to2MaleInd", "Age0to2FemaleInd", "Age0to2UnknownApiderInd", "Age3to5MaleInd", "Age3to5FemaleInd", "Age3to5UnknownApiderInd", "Age6to10MaleInd", "Age6to10FemaleInd", "Age6to10UnknownApiderInd", "Age11to15MaleInd", "Age11to15FemaleInd", "Age11to15UnknownApiderInd", "Age16to17MaleInd", "Age16to17FemaleInd", "Age16to17UnknownApiderInd", "Age18to24MaleInd", "Age18to24FeMaleInd", "Age18to24UnknownApiderInd", "Age25to34MaleInd", "Age25to34FeMaleInd", "Age25to34UnknownApiderInd", "Age35to44MaleInd", "Age35to44FeMaleInd", "Age35to44UnknownApiderInd", "Age45to54MaleInd", "Age45to54FeMaleInd", "Age45to54UnknownApiderInd", "Age55to64MaleInd", "Age55to64FeMaleInd", "Age55to64UnknownApiderInd", "Age65to74MaleInd", "Age65to74FeMaleInd", "Age65to74UnknownApiderInd", "Age75MaleInd", "Age75FeMaleInd", "Age75UnknownApiderInd", "YoungAdultinHouseholdInd", "ApierationsInHouseholdCount", "SeniorAdultInHouseholdInd", "HomeLengthofResidenceCode", "CensusMedianHomeValue", "CensusMedianHouseholdIncome", "DwellingTypeCode", "AdvantageDwellingTypeInd", "HomeYearBuiltCode", "HomePropertyTypeCode", "HomePurchaseDate", "NewToBuildIndicator", "HomeLotSquareFootageRangesCode", "HomePurchaseAmountRangesCode", "HomePropertyTypeDetailCode", "HomeLTVEstimatedRangesCode", "HomeLTVEstimatedActualCode", "MailOrderDonorInd", "LotCarrierlineOfTravelCode", "FileDate", "CompanyId", "IndividualId", "ConfidenceUseCode", "SupportsCharitableInd", "SupportsAnimalWelfareInd", "SupportsArtsOrCulturalInd", "SupportsEnvironmentOrWildlifeInd", "SupportsHealthInd", "SupportsInternationalAidInd", "SupportsPoliticalInd", "SupportsPoliticalConservativeInd", "SupportsPoliticalLiberalInd", "SupportsReligiousInd", "SupportsVeteransInd", "AfricanAmericanProfessionals", "BusinessOwnerCode", "SingleParentInd", "VeteranInd", "OccupationDetailInputIndividualCode", "InferredHouseholdRankCode", "VehicleNewUsedInd1", "VehicleNewUsedInd2", "GreenLivingInd", "AgeinTwoYearIncrInputIndReseller", "SmallOfficeHouseholdInd", "TruckOwnerInd", "InvestmentPropertiesOwnedEstimated", "NetWorthCode", "WorkingWomanInd", "BankCardHolderInd", "GasDepartmentRetailCardHolderInd", "TravelAndEntCardHolderInd", "CreditCardHolderUnknownTypeInd", "PremiumCardHolderInd", "UpscaleDeptStoreCardHolderInd", "OccupationInputIndividualCode", "InfoBasePositiveMatchInd", "OverallMatchInd", "OwnerRenterCode", "CatOwnerInd", "DogOwnerInd", "OtherPetOnwerInd", "MaritalStatus", "MailOrderResponderInd", "SupportsOtherInd", "CongressionalDistrictCode", "MotorcycleOwnerInd", "RecreationalVehicleInd", "PoliticalPartyInputIndividualCode", "BaseRecordVerificationDate", "NumberofSources", "VehicleNewCarBuyer", "VehicleKnownOwnedNumber", "VehicleDominantLifestyleCode", "CreditCardUserInd", "CRAIncomeClassificationCode", "EducationInputIndividualCount", "CollegeGraduateInd", "PrecisionLevelCode", "WirelessProductBuyerInd", "FashionInd", "HistoyMilitaryInd", "CelebritiesInd", "CurrentAffairsPoliticsInd", "TheaterPerformingArtsInd", "CommunityCharitiesInd", "ReligiousInspirationalInd", "ScienceSpaceInd", "StrangeandUnusualInd", "CareerImprovementInd", "ArtsInd", "ReadingApieralInd", "ReadingBestSellersInd", "ReadingReligiousInspirationalInd", "ReadingScienceFictionInd", "ReadingMagazinesInd", "ReadingAudioBooksInd", "CookingApieralInd", "CookingGourmetInd", "CookingLowFatInd", "FoodsVegetarianInd", "FoodsNaturalInd", "TravelDomesticInd", "TravelInternationalInd", "RecreationalVehiclesInd", "TravelFamilyVacationsInd", "TravelCruiseVacationsInd", "ExerciseRunningJoggingInd", "ExerciseWalkingInd", "ExerciseAerobicInd", "CraftsInd", "PhotographyInd", "AviationInd", "AutoWorkInd", "SewingKnittingNeedleworkInd", "WoodWorkingInd", "GamesBoardGamesPuzzlesInd", "MusicHomeStereoInd", "MusicPlayerInd", "MusicCollectorInd", "MusicAvidListenerInd", "MovieCollectorInd", "TVCableInd", "GamesVideoGamesInd", "MoviesatHomeInd", "TVSatelliteDishInd", "DietingWeightLossInd", "SelfImprovementInd", "HousePlantsInd", "ParentingInd", "ChildrensInterestsInd", "GrandChildrenInd", "SpectatorSportsRacingInd", "SpectatorSportsFootballInd"

## Response 200 fields (application/json):

  - `JobId` (string)
    The JobId to be used to purchase and access the full dataset.

  - `Count` (integer)
    Number of records returned by the query.

  - `ResultCode` (string)
    Success or Error codes based on the response/request.

  - `Sample` (array)
    A 10 record sample response.

## Response 400 fields (application/json):

  - `type` (string)
    The type of error that occurred.

  - `title` (string)
    A short summary of the error.

  - `status` (integer)
    The HTTP status code for the error.

  - `errors` (object)

  - `errors.$.<PropertyName>` (array)
    A detailed message about the error.

  - `traceId` (string)
    A unique identifier for the request, useful for debugging.