Get sample data and counts matching your ideal customer profile.

post

https://api.visualvisitor.com/api/v1/plusEmployee/icp/sampleData

Queried customer must have a +PlusEmployee plan enabled.
Minimal scope required: "customers.read".

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

customerId

string | null

Optional query parameter, allowing partners to perform this action on behalf of their customer.

api-version

string | null

Body Params

The JSON object containing the ideal customer profile filter to test.

Defines the filter used by an ideal customer profile.

jobTitles

array of strings | null

Optional, search by the visitor's job title.

jobTitles

jobLevelValues

array of strings | null

Optional, search by visitor having a matching job level.
Required values can be retrieved from the endpoint: /api/v1/reference/jobLevels.

jobLevelValues

jobFunctionLevels

array of strings | null

Optional, search by visitor having a matching job function.
Required values can be retrieved from the endpoint: /api/v1/reference/jobFunctions.

jobFunctionLevels

companyNames

array of strings | null

Optional, search by company names.

companyNames

companyWebsites

array of strings | null

Search by company websites.

companyWebsites

companyIndustryValues

array of strings | null

Optional, search by company industries.
Required values can be retrieved from the endpoint: /api/v1/reference/companyIndustries.

companyIndustryValues

companySicValues

array of strings | null

Optional, search by company SIC codes.
Required values can be retrieved from the endpoint: /api/v1/reference/companySics.

companySicValues

companyNaicsValues

array of strings | null

Optional, search by company NAICS codes.
Required values can be retrieved from the endpoint: /api/v1/reference/companyNaics.

companyNaicsValues

companyEmployeeSizeVaules

array of strings | null

Optional, search by company size IDs.
Required values can be retrieved from the endpoint: /api/v1/reference/companyEmployeeSizes.

companyEmployeeSizeVaules

companyRevenueBandValues

array of strings | null

Optional, The list of company revenue bands to filter by.
Required values can be retrieved from the endpoint: /api/v1/reference/companyRevenueBands.

companyRevenueBandValues

stateValues

array of strings | null

Optional, search by states.
Required values can be retrieved from the endpoint: /api/v1/reference/states.

stateValues

cities

array of strings | null

Optional, search by cities.

cities

zipCodes

array of strings | null

Optional, search by zip codes.

zipCodes

firstName

string | null

Optional, search by the visitor's first name.

lastName

string | null

Optional, search by the visitor's last name.

almaMater

array of strings | null

Optional, search by the visitor's alma mater.

almaMater

fromAge

int32 | null

Optional, search by the minimum age.

toAge

int32 | null

Optional, search by the maximum age.

contactSkills

array of strings | null

Optional, search by the visitor's contact skills.

contactSkills

formerEmployer

array of strings | null

Search by the visitor's former employers.

formerEmployer

personalEmailRequired

boolean

Indicates whether the visitor is required to have a personal email addresses.

cellPhoneRequired

boolean

Indicates whether the visitor is required to have a cell phone number.

primaryContactsOnly

boolean

Only include primary contacts.

professionalEmailRequired

boolean

Indicates whether the visitor is required to have a professional email address is required.

phoneRequired

boolean

Indicates whether the visitor is required to have a phone number.

Headers

X-Version

string | null

Responses

500

200

400

401

403

404

422