AdvancedDiscoverPerson
List of current positions where the person works
firstNamePerson first name
idAggKnowledge Person ID
lastNamePerson last name
linkedinUrlNormalized Linkedin URL
Company attributes for the matched work experience
Product attributes for the matched work experience
personCountryPerson's country
personLocalityPerson's locality (city)
personRegionPerson's region (state)
AdvancedDiscoverSearchRequest
Filters for company index (firmographic data)
cursorPagination cursor from previous response for fetching next page of results
limitMaximum number of results to return per page (default: 100, max: 1000)
Caller-supplied metadata associated with the request
Filters for person attributes (location)
Filters for vendorgraphics index (products and categories)
Filters for work experience index (job titles, roles, etc.)
AdvancedDiscoverSearchResponse
List of persons matching the search criteria
hasProblemsWhether the response contains any problems
isRetryableWhether the operation is retryable in case of failure
isSuccessWhether the operation was successful
Caller-supplied metadata echoed back from the request
nextCursorPagination cursor for fetching the next page of results
AsyncCompanyOperationsDto
isUpdatingCompetitorsWhether the company's competitors are being updated asynchronously.
isUpdatingDescriptionWhether the company description is being updated asynchronously.
isUpdatingProductsWhether the company's products are being updated asynchronously.
Category
idUnique identifier for the category
nameName of the category
CategoryHierarchyItem
categoryIdUnique identifier for the category
levelLevel of the category in the hierarchy, where 1 is the highest level and broadest category
nameName of the category at this level in the hierarchy
CategoryListResponse
List of product categories
cursorCursor for pagination. Use this value as the cursor parameter in the next request to get more results.
CompanyDescriptionItem
aggkCompanyIdAggK Company ID
descriptionCompany description if available
isCompanyNotFoundSet to true if the company was not found in the database
wasDescriptionRejectedWhether the description for this company was rejected/blocked
willDescriptionBeGeneratedWhether a description will be generated for this company in the future
CompanyDescriptionRequest
companyIdsList of AggK Company IDs to fetch descriptions for (max 500)
CompanyDescriptionResponse
List of company descriptions
isRetryableIf the request failed, whether the request is retryable with the same input. Always true for successful requests.
isSuccessWhether or not the request resulted in a successful enrichment.
Caller-supplied metadata associated with the request
CompanyEnrichmentRequest
companyIdCompany ID
linkedinUrlCompany LinkedIn URL. This value will be normalized server-side.
linkedinUsernameCompany LinkedIn username
Optional metadata to associate with the request. Will be returned in the response.
websiteCompany website
CompanyEnrichmentRequestParameters
companyIdCompany ID
linkedinUrlCompany LinkedIn URL. This value will be normalized server-side.
linkedinUsernameCompany LinkedIn username
websiteCompany website
CompanyEnrichmentResponse
If hasAsyncOperations is true, this field will describe which async operations are in progress.
Complete company details including competitors and ultimate parent.
Caller-supplied inputs echoed back in the response
isRetryableIf the request failed, whether the request is retryable with the same input. Always true for successful requests.
isSuccessWhether or not the request resulted in a successful enrichment.
Caller-supplied metadata associated with the request
CompanyFilter
AggKnowledge Company ID filter
companyFilterCompany filter mode: WORK_EXPERIENCE (default) or RELATIONSHIP
Company name filter (supports partial/phrase matching)
Company type filter
Company website filter
Company country
Employee count range filter
Funding round count range
Total funding range
Industry filter
Latest funding amount range
Latest funding date range
Latest funding stage filter
Company locality
Primary exchange filter
Primary ticker symbols filter
Company region
relationshipTypeRelationship type filter (only used when companyFilter=RELATIONSHIP)
Revenue range inferred filter
CompanyMatchRequest
Filter by company type
Filter by country
Filter by employee count range
Filter by funding round count (min/max)
Filter by total funding amount (min/max)
Filter by industry
Filter by latest funding amount (min/max)
Filter by latest funding date (gte/lte, supports YYYY, YYYY-MM, or YYYY-MM-DD)
Filter by latest funding stage
Filter by locality (city)
Filter by company name (searches name, display name, and alternative names)
Filter by primary stock exchange
Filter by primary ticker symbol
Filter by region (state/province)
Filter by inferred revenue range
Filter by social profile URL (searches LinkedIn URL and social profile fields; input is normalized to strip protocol, subdomain, and query string while preserving path)
Filter by website (searches website and domain fields; input is normalized to strip protocol and query string)
CompanyMetadata
aggkCompanyIdAggKnowledge company ID
linkedinUrlLinkedIn URL
nameCompany name
websiteCompany website
CompanyRelationship
aggkCompanyIdfirstSeenAtDate when relationship was first seen
lastSeenAtDate when relationship was last seen
linkedinUrlnamerelationshipTypeRelationship type
CompanyRelationshipsRequest
companyIdCompany ID to fetch relationships for
cursorCursor for pagination. Use the cursor value from the previous response to get more results. Important: When using pagination with filters (like lastSeenAfter), you must include the same filter parameters in subsequent requests along with the cursor.
lastSeenAfterFilter relationships by last_seen_at date. Returns only relationships where last_seen_at is on or after this date. Accepts YYYY, YYYY-MM, or YYYY-MM-DD format. Note: This filter must be included in all paginated requests (along with the cursor) to maintain consistent results.
Optional metadata to associate with the request. Will be returned in the response.
CompanyRelationshipsResponse
List of company relationships
Metadata of the company for which relationships are being fetched
cursorCursor for pagination. Use this value as the cursor parameter in the next request to get more results.
hasProblemsWhether there are problems in the response
isRetryableWhether the operation is retryable
isSuccessWhether the operation was successful
Caller-supplied metadata associated with the request
CompanyVendorgraphicsEnrichmentRequest
companyIdThe AggKnowledge company ID.
Optional metadata to associate with the request. Will be returned in the response.
CompanyVendorgraphicsEnrichmentResponse
isRetryableIf the request failed, whether the request is retryable with the same input. Always true for successful requests.
isSuccessWhether or not the request resulted in a successful enrichment.
Caller-supplied metadata associated with the request
Competitor
companyIdCompany ID
competitiveDescriptionBrief description of the competitor
competitorNameCompetitor Name
CompleteCompany
addressLine1Company address line 1
addressLine2Company address line 2
cityCity or metro area
companyTypeType of company
countryCountry
descriptionBrief description of the company
displayNameCompany display name
employeeCountActualActual number of employees
employeeCountRangeBucketed number of employees
fundingRoundCountNumber of funding rounds the company has participated in
fundingTotalTotal amount of funding raised and publicly disclosed, in USD
idCompany ID
industryPrimary industry
isDescriptionReviewedByHumanWhether the description has been reviewed by a human
isStructuredEntityWhether this entity could be matched to a known company
latestFundingAmountAmount of latest funding round, if known
latestFundingDateLatest funding date
latestFundingStageLatest funding stage
linkedinIdCompany LinkedIn ID
linkedinUrlNormalized company LinkedIn URL
nameNormalized company name
pdlCompanyIdPDL company ID
postalCodePostal code
primaryExchangePrimary stock exchange
primaryTickerPrimary stock ticker
revenueRangeInferredInferred revenue range
stateOrProvinceState or province
wasDescriptionRejectedWhether a description was previously generated for this company but did not pass quality screening.
websiteNormalized company website
willDescriptionBeGeneratedIf description is null, whether a description will be generated. If description is not null, this will be false.
ContactDataUsageBreakdown
averageDailyUsageLast30Dayslast1Daylast30Dayslast7DaysCurrentCompany
aggkCompanyIdAggKnowledge Company ID
companyTypeCompany type
currentStartDateAtCompanyStart date of the person's current stint at the company
nameCompany name
originalStartDateAtCompanyStart date of the person's earliest stint at the company
totalStintsAtCompanyTotal number of stints the person has had at the company
CurrentPosition
aggkCompanyIdAggKnowledge Company ID
companyTypeCompany type
currentStartDateAtCompanyStart date of the person's current stint at the company
jobTitleJob title
nameCompany name
originalStartDateAtCompanyStart date of the person's earliest stint at the company
totalStintsAtCompanyTotal number of stints the person has had at the company
CustomerAndUsage
A lightweight representation of a company primarily used for search results.
List of usage objects, one per product the company uses
DateRangeFilter
gteGreater than or equal to date (YYYY, YYYY-MM, or YYYY-MM-DD)
lteLess than or equal to date (YYYY, YYYY-MM, or YYYY-MM-DD)
DiscoverCountResponse
countNumber of matching persons for the given search criteria
hasProblemsWhether the response contains any problems
isRetryableWhether the operation is retryable in case of failure
isSuccessWhether the operation was successful
Caller-supplied metadata echoed back from the request
DiscoverPersonSearchRequest
aggkCompanyIdAggKnowledge Company IDs to restrict search to specific companies
aggkProductIdAggKnowledge Product IDs
categoryIdCategory IDs
companyTypeCompany type
countryCompany country
cursorPagination cursor from previous response for fetching next page of results
earliestCurrentStartDateAtCompanyEarliest current stint start date at the company (YYYY, YYYY-MM, or YYYY-MM-DD)
earliestEndDateEarliest end date for work experiences (YYYY, YYYY-MM, or YYYY-MM-DD)
earliestOriginalStartDateAtCompanyEarliest original start date at the company (YYYY, YYYY-MM, or YYYY-MM-DD)
earliestStartDateEarliest start date for work experiences (YYYY, YYYY-MM, or YYYY-MM-DD)
employeeCountRangeEmployee count ranges
Funding round count range
Total funding range
industryIndustry categories
jobTitleJob titles
latestCurrentStartDateAtCompanyLatest current stint start date at the company (YYYY, YYYY-MM, or YYYY-MM-DD)
latestEndDateLatest end date for work experiences (YYYY, YYYY-MM, or YYYY-MM-DD)
Latest funding amount range
Latest funding date range
latestFundingStageLatest funding stage
latestOriginalStartDateAtCompanyLatest original start date at the company (YYYY, YYYY-MM, or YYYY-MM-DD)
latestStartDateLatest start date for work experiences (YYYY, YYYY-MM, or YYYY-MM-DD)
limitMaximum number of results to return per page (default: 100, max: 1000)
localityCompany locality
Caller-supplied metadata associated with the request
personCountryPerson country
personFilterPerson employment filter
personLocalityPerson locality (city)
personRegionPerson region (state)
primaryExchangePrimary exchanges
primaryTickerPrimary ticker symbols
regionCompany region
revenueRangeInferredRevenue range inferred
roleRoles
senioritySeniority levels
subroleSub-roles
DiscoverPersonSearchResponse
List of persons matching the search criteria
hasProblemsIndicates if there are any problems with the request
isRetryableIndicates if the request is retryable
isSuccessIndicates if the request was successfully processed
Caller-supplied metadata associated with the request
nextCursorPagination cursor for fetching the next page of results
warningsNon-fatal warnings about the search, such as filter degradation due to scale
DiscoverValidationResponse
isValidWhether all provided values are valid (true when warnings is empty)
Caller-supplied metadata echoed back from the request
List of validation warnings, one per invalid field value
DiscoverValidationWarning
codeMachine-readable warning code (e.g. 'INVALID_ENUM_VALUE', 'INVALID_DATE_FORMAT', 'MUTUALLY_EXCLUSIVE_FIELDS')
fieldThe field name that contains the invalid value (e.g. 'role', 'industry')
messageHuman-readable description of the validation problem
validValuesValid values accepted for this field, when applicable
valueThe invalid value that was provided. Absent for warnings that are not tied to a specific value (e.g. MUTUALLY_EXCLUSIVE_FIELDS).
FieldFilterLong
andValues that must ALL be present (AND logic)
notValues that must NOT be present (NOT logic)
orValues where at least ONE must be present (OR logic)
FieldFilterString
andValues that must ALL be present (AND logic)
notValues that must NOT be present (NOT logic)
orValues where at least ONE must be present (OR logic)
FundingStage
Stage of funding for a company
GenericProblem
correlationIdThe correlation ID for this request. Provide this ID when contacting support.
detailA human-readable explanation specific to this occurrence of the problem.
statusThe HTTP status code generated by the origin server for this occurrence of the problem.
titleA brief title for the problem.
Industry
IntegerRangeFilter
maxMaximum value (inclusive)
minMinimum value (inclusive)
JobClass
JobRoleV2
JobSubRoleV2
JobTitleNormalizationRequest
jobTitleJob title to normalize
Optional metadata to associate with the request. Will be returned in the response.
JobTitleNormalizationResponse
Job title normalization result
The original request parameters
isRetryableIf the request failed, whether the request is retryable with the same input. Always true for successful requests.
isSuccessWhether or not the request resulted in a successful enrichment.
Caller-supplied metadata associated with the request
JsonNode
arraybigDecimalbigIntegerbinarybooleancontainerdoubleembeddedValueemptyfloatfloatingPointNumberintintegralNumberlongmissingNodenodeTypenullnumberobjectpojoshortstringvalueNodetextualLinkedinUrlNormalizationRequest
linkedinUrlLinkedIn URL to normalize
Optional metadata to associate with the request. Will be returned in the response.
LinkedinUrlNormalizationResponse
Normalized LinkedIn URL result
The original request parameters
isRetryableIf the request failed, whether the request is retryable with the same input. Always true for successful requests.
isSuccessWhether or not the request resulted in a successful enrichment.
Caller-supplied metadata associated with the request
LinkedinUsernameExtractionRequest
linkedinUrlLinkedIn URL to extract username from
Optional metadata to associate with the request. Will be returned in the response.
LinkedinUsernameExtractionResponse
LinkedIn username extraction result
The original request parameters
isRetryableIf the request failed, whether the request is retryable with the same input. Always true for successful requests.
isSuccessWhether or not the request resulted in a successful enrichment.
Caller-supplied metadata associated with the request
LiteCompany
aggkCompanyIddisplayNamenamepdlCompanyIdLongRangeFilter
maxMaximum value (inclusive)
minMinimum value (inclusive)
MatchingCompany
aggkCompanyIdAggKnowledge Company ID
currentStartDateAtCompanyStart date of the person's current stint at the company
endDateEnd date of the work experience
jobTitleJob title at the company
nameCompany name
originalStartDateAtCompanyStart date of the person's earliest stint at the company
rolePerson role at the company
seniorityPerson seniority at the company
startDateStart date of the work experience
subrolePerson subrole at the company
totalStintsAtCompanyTotal number of stints the person has had at the company
MatchingProduct
aggkProductIdAggKnowledge Product ID
detectionFirstSeenAtEarliest date the product was detected at the company
detectionLastSeenAtMost recent date the product was detected at the company
productNameProduct name
Person
bioPerson biography
dateLastUpdatedDate the person's data was last refreshed
firstNamePerson first name
idAggKnowledge Person ID
lastNamePerson last name
linkedinUrlNormalized Linkedin URL
linkedinUsernameNormalized Linkedin username
locationCityLocation city
locationCountryLocation country
locationMetroLocation metro area
locationPostalCodeLocation postal code
locationStateOrProvinceLocation state or province
middleNamePerson middle name
primaryWorkExperienceIdThe person's primary work experience ID. If present, this ID will be in the work experience list. If not present, we were unable to determine which work experience should be considered primary.
List of tags associated with the person
PersonBulkEnrichmentBatchDto
correlationIdCorrelation ID
createdAtCreated at timestamp
idBatch ID
isPurgedWhether the batch has been purged
updatedAtUpdated at timestamp
PersonBulkEnrichmentCreateResponse
batchIdThe batch ID of the bulk enrichment request. Use this to check the status of the request and fetch the data.
PersonBulkEnrichmentItem
itemIdstatusEnrichment item status
PersonBulkEnrichmentItemsResponse
cursorCursor for pagination. Use this value as the cursor parameter in the next request to get more results.
List of enriched person data
PersonBulkEnrichmentStatusResponse
statusEnrichment item status
PersonContactDataBatchResponse
completedItemsNumber of completed items
failedItemsNumber of failed items
idBatch UUID
List of contact data items
statusBatch status
totalItemsTotal number of items in the batch
PersonContactDataItemSummary
aggkPersonIdAggk person ID
List of email addresses found
enrichPersonalEmailWhether personal email was requested
enrichPhoneWhether phone was requested
enrichWorkEmailWhether work email was requested
Metadata provided with the request
mostProbablePersonalEmailMost probable personal email
mostProbablePersonalEmailStatusMost probable personal email status
mostProbablePhoneMost probable phone
mostProbableWorkEmailMost probable work email
mostProbableWorkEmailStatusMost probable work email status
List of personal email addresses found
List of phone numbers found
statusProcessing status
PersonContactDataRequest
aggkPersonIdenrichPersonalEmailenrichPhoneenrichWorkEmailPersonContactDataResponse
batchIdBatch UUID for tracking the request
itemCountNumber of items in the request
messageStatus message
PersonEnrichmentProblem
correlationIdThe correlation ID for this request. Provide this ID when contacting support.
detailA human-readable explanation specific to this occurrence of the problem.
statusThe HTTP status code generated by the origin server for this occurrence of the problem.
titleA brief title for the problem.
PersonEnrichmentProblems
linkedinProfileNotFoundWhether the profile was not found when scraping.
transientScrapingVendorFailureWhether a call to an upstream vendor failed during the request.
PersonEnrichmentRequest
Optional metadata to associate with the request. Will be returned in the response.
pdlIdThe person's PDL ID.
personIdThe AggKnowledge person ID.
professionalSocialMediaUrlLinkedIn URL of the person. Protocol and subdomain are optional, this value will be normalized server-side. Sales Nav and Recruiter URLs are allowed.
PersonEnrichmentRequestParameters
pdlIdThe person's PDL ID.
personIdThe AggKnowledge person ID.
professionalSocialMediaUrlLinkedIn URL of the person. Protocol and subdomain are optional, this value will be normalized server-side. Sales Nav and Recruiter URLs are allowed.
PersonEnrichmentResponse
The enriched person data, if the request was successful.
Caller-supplied inputs echoed back in the response
isRetryableIf the request failed, whether the request is retryable with the same input. Always true for successful requests.
isSuccessWhether or not the request resulted in a successful enrichment.
Caller-supplied metadata associated with the request
If hasProblems is true, this field will describe which problems were encountered.
PersonEnrichmentValidationResponse
hasSufficientIdentifiersWhether the request has sufficient identifiers to proceed with enrichment
isLinkedinUrlValidWhether any provided LinkedIn URL is valid
isValidWhether the request is valid for enrichment
Metadata from the original request
validationMessageDescription of any validation issues found
PersonFilter
AggKnowledge Person ID filter. Only 'not' is supported (to exclude specific persons from results); supplying 'or' or 'and' will result in an error. Maximum 1,000 values in 'not'.
Person country filter
Person locality (city) filter
Person region (state) filter
PersonLite
aggkCompanyIdAggKnowledge Company ID
aggkProductIdAggKnowledge Product ID
companyCompany name
List of current companies where the person works
currentStartDateAtCompanyStart date of the person's current stint at the matched company
endDateEnd date of the matched work experience
firstNamePerson first name
idAggKnowledge Person ID
jobTitleJob title
lastNamePerson last name
linkedinUrlNormalized Linkedin URL
Company attributes for the matched work experience
Product attributes for the matched work experience
originalStartDateAtCompanyStart date of the person's earliest stint at the matched company
personCountryPerson's country
personLocalityPerson's locality (city)
personRegionPerson's region (state)
productNameProduct name relevant to the search
rolePerson role
seniorityPerson seniority
startDateStart date of the matched work experience
subrolePerson subrole
totalStintsAtCompanyTotal number of stints the person has had at the matched company
PersonMatchRequest
companyDomainsCurrent or former employer domains of the person.
companyNamesCurrent or former employer names of the person.
emailAddressesCurrent or former email addresses of the person.
fullNameThe person's full name. Either fullName or linkedinUrl must be provided.
linkedinUrlLinkedIn URL of the person. Either fullName or linkedinUrl must be provided.
locationCityCity where the person is located.
locationCountryCountry where the person is located.
locationStateOrProvinceState or province where the person is located.
PersonSearchRequest
currentOrPastEmailAddressA current or former email address of the person.
currentOrPastEmployerDomainA current or former employer domain of the person.
currentOrPastEmployerNameA current or former employer name of the person.
fullNameThe person's full name.
PersonSearchResult
fullNamehasEmailisEmailMatchlinkedinUsernamelocationCitylocationCountrylocationStateOrProvincepersonIdpreviousEmployerDomainspreviousEmployerNamesPersonVendorgraphicsEnrichmentRequest
Optional metadata to associate with the request. Will be returned in the response.
personIdThe AggKnowledge person ID.
PersonVendorgraphicsEnrichmentResponse
isRetryableIf the request failed, whether the request is retryable with the same input. Always true for successful requests.
isSuccessWhether or not the request resulted in a successful enrichment.
Caller-supplied metadata associated with the request
Product
descriptionProduct description, if available
idAggKnowledge product ID
nameProduct name
vendorAggkCompanyIdAggKnowledge company ID of the vendor offering this product, if applicable
ProductCompanyDetection
aggkCompanyIdfirstSeenAtThe first date when the product was observed being used at this company
lastSeenAtThe most recent date when the product was observed being used at this company
ProductFamiliarToPerson
descriptionProduct description, if available
idAggKnowledge product ID
nameProduct name
vendorAggkCompanyIdAggKnowledge company ID of the vendor offering this product, if applicable
ProductListResponse
cursorCursor for pagination. Use this value as the cursor parameter in the next request to get more results.
List of products
ProductOffered
descriptionProduct description, if available
idAggKnowledge product ID
nameProduct name
vendorAggkCompanyIdAggKnowledge company ID of the vendor offering this product, if applicable
ProductUsageSignal
dnsDetectionCountThe count of usage signals derived from DNS detections in the specified time period.
jobOpeningCountThe count of usage signals derived from job openings in the specified time period.
reviewCountThe count of usage signals derived from product reviews in the specified time period.
timePeriodThe time bucket for the usage signal data.
totalCountThe total count of product usage signals in the specified time period.
webDetectionCountThe count of usage signals derived from web detections in the specified time period.
ProductUsed
descriptionProduct description, if available
firstObservationThe first date when the product was observed being used
idAggKnowledge product ID
lastObservationThe most recent date when the product was observed being used
nameProduct name
Usage signals for the product across all time periods, starting in 2012
Usage signals bucketed by time period
vendorAggkCompanyIdAggKnowledge company ID of the vendor offering this product, if applicable
ProductWithVendorDto
descriptionProduct description, if available
idAggKnowledge product ID
nameProduct name
vendorAggkCompanyIdAggKnowledge company ID of the vendor offering this product, if applicable
vendorNameProductWorkExperienceAssociation
aggkCompanyIdID of the company where the person worked
aggkExperienceIdID of the work experience
companyNameName of company where the person worked
endDateEnd date of the work experience, null if role is current
roleJob role using V2 methodology
startDateStart date of the work experience
subRoleJob subrole using V2 methodology
titleNormalized job title
RateLimitInfo
maxRequestsPerHourmaxRequestsPerSecondtierRevenueRange
Role
v2Job role using V2 methodology
v1Job role using V1 methodology (deprecated)
SubRole
v2Job subrole using V2 methodology
v1Job subrole using V1 methodology (deprecated)
Tag
confidenceLevelConfidence level of the tag
descriptionBrief description of tag, if available
nameTag name
List of work experiences related to the tag
typeTag type
TagWorkExperience
companyNameCompany name
jobRoleJob role using V2 methodology
jobSubRoleJob subrole using V2 methodology
jobTitleJob title
workExperienceIdAggKnowledge Work Experience ID
Technographic
descriptionBrief description of the product
lastObservationDate of most recent observation
productIdAggKnowledge Product ID
productNameProduct Name
vendorIdAggKnowledge Vendor ID
Indications of product usage
TechnographicIndication
jobOpeningsCountCount of job openings indicating usage of the product
reviewsCountCount of product reviews indicating usage of the product
webDetectionCountCount of web detections indicating usage of the product
UltimateParentCompany
addressLine1Company address line 1
addressLine2Company address line 2
cityCity or metro area
companyTypeType of company
countryCountry
descriptionBrief description of the company
displayNameCompany display name
employeeCountActualActual number of employees
employeeCountRangeBucketed number of employees
fundingRoundCountNumber of funding rounds the company has participated in
fundingTotalTotal amount of funding raised and publicly disclosed, in USD
idCompany ID
industryPrimary industry
isDescriptionReviewedByHumanWhether the description has been reviewed by a human
isStructuredEntityWhether this entity could be matched to a known company
latestFundingAmountAmount of latest funding round, if known
latestFundingDateLatest funding date
latestFundingStageLatest funding stage
linkedinIdCompany LinkedIn ID
linkedinUrlNormalized company LinkedIn URL
nameNormalized company name
pdlCompanyIdPDL company ID
postalCodePostal code
primaryExchangePrimary stock exchange
primaryTickerPrimary stock ticker
revenueRangeInferredInferred revenue range
stateOrProvinceState or province
wasDescriptionRejectedWhether a description was previously generated for this company but did not pass quality screening.
websiteNormalized company website
willDescriptionBeGeneratedIf description is null, whether a description will be generated. If description is not null, this will be false.
VendorgraphicsFilter
AggKnowledge Product ID filter
Category ID filter
detectionPeriodBufferExpands the detection window symmetrically in both directions when filterByDetectionPeriod is active. For example, SIX_MONTHS subtracts 180 days from first_seen_at and adds 180 days to last_seen_at.
filterByDetectionPeriodWhen true, restricts results to people whose tenure at a product-using company overlaps with the product's detection window (first_seen_at to last_seen_at). Only applies when a product filter is present. If the matched company count exceeds 1000, detection-period overlap is not enforced and results fall back to a plain company ID filter.
VendorgraphicsSearchCategoryCustomersRequest
categoryIdThe AggKnowledge category ID to search for customers.
cursorCursor for pagination. Use the cursor value from the previous response to get more results.
Optional metadata to associate with the request. Will be returned in the response.
VendorgraphicsSearchProductCustomersRequest
productIdThe AggKnowledge product ID to search for customers.
cursorCursor for pagination. Use the cursor value from the previous response to get more results.
Optional metadata to associate with the request. Will be returned in the response.
VendorgraphicsSearchProductCustomersResponse
cursorCursor for the next page of results. Null if there are no more results.
isRetryableIf the request failed, whether the request is retryable with the same input. Always true for successful requests.
isSuccessWhether or not the request resulted in a successful enrichment.
Caller-supplied metadata associated with the request
WebsiteNormalizationRequest
websiteWebsite URL to normalize
Optional metadata to associate with the request. Will be returned in the response.
WebsiteNormalizationResponse
Website normalization result
The original request parameters
isRetryableIf the request failed, whether the request is retryable with the same input. Always true for successful requests.
isSuccessWhether or not the request resulted in a successful enrichment.
Caller-supplied metadata associated with the request
WorkExperience
Complete company details including competitors and ultimate parent.
descriptionJob description
endDate^[0-9]{4}(-[0-9]{2})…End date
idAggKnowledge Work Experience ID
jobClassClass of the job
senioritySeniority level of the job
startDate^[0-9]{4}(-[0-9]{2})…Start date
titleNormalized job title
titleRawRaw job title as originally provided
WorkExperienceFilter
Date range filter for when a person started their current stint at the company
End date range filter for work experiences
Job title filter
Date range filter for when a person originally started at the company
personFilterPerson employment filter (CURRENT or PAST_NOT_CURRENT)
Role filter
Seniority filter
Start date range filter for work experiences
Sub-role filter