AggKnowledge API

Discover Advanced

Endpointhttps://api.aggknowledgeai.com

V2 APIs for advanced discover search

Advanced Discover Search

POST

https://api.aggknowledgeai.com

/v2/{environment}/discover/people/advanced

Returns persons matching complex criteria with or/not semantics organized by index (vendorgraphics, company, workExperience) (Tier 2)

Advanced Discover Search › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Advanced Discover Search › query Parameters

format

string

Output format: 'json' (default) or 'csv'

Default: json

Advanced Discover Search › Headers

x-api-key

string · required

API key for authentication

Advanced Discover Search › Request Body

Advanced discover search request

object

Filters for company index

cursor

string

Pagination cursor from previous response for fetching next page of results

limit

integer · int32

Maximum number of results to return per page (default: 100, max: 1000)

object

Caller-supplied metadata associated with the request

object

Filters for person attributes

object

Filters for vendorgraphics index

object

Filters for work experience index

Advanced Discover Search › Responses

Advanced discover search results

Response containing search results

object[]

List of persons matching the search criteria

hasProblems

boolean

Whether the response contains any problems

isRetryable

boolean

Whether the operation is retryable in case of failure

isSuccess

boolean

Whether the operation was successful

object

Caller-supplied metadata echoed back from the request

nextCursor

string

Pagination cursor for fetching the next page of results

POST/v2/{environment}/discover/people/advanced

curl --request POST \
  --url https://api.aggknowledgeai.com/v2/:environment/discover/people/advanced \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <string>' \
  --data '
{
  "company": {
    "aggkCompanyId": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "companyFilter": "WORK_EXPERIENCE",
    "companyName": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "companyType": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "companyWebsite": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "country": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "employeeCountRange": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "fundingRoundCount": {
      "max": 0,
      "min": 0
    },
    "fundingTotal": {
      "max": 0,
      "min": 0
    },
    "industry": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "latestFundingAmount": {
      "max": 0,
      "min": 0
    },
    "latestFundingDate": {
      "gte": "gte",
      "lte": "lte"
    },
    "latestFundingStage": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "locality": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "primaryExchange": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "primaryTicker": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "region": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "relationshipType": "CUSTOMER_VENDOR",
    "revenueRangeInferred": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    }
  },
  "cursor": "cursor",
  "limit": 100,
  "metadata": {
    "key": "string"
  },
  "person": {
    "aggkPersonId": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "personCountry": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "personLocality": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "personRegion": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    }
  },
  "vendorgraphics": {
    "aggkProductId": {
      "and": [
        0
      ],
      "not": [
        0
      ],
      "or": [
        0
      ]
    },
    "categoryId": {
      "and": [
        0
      ],
      "not": [
        0
      ],
      "or": [
        0
      ]
    },
    "detectionPeriodBuffer": "SIX_MONTHS",
    "filterByDetectionPeriod": true
  },
  "workExperience": {
    "currentStartDateAtCompany": {
      "gte": "gte",
      "lte": "lte"
    },
    "endDate": {
      "gte": "gte",
      "lte": "lte"
    },
    "jobTitle": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "originalStartDateAtCompany": {
      "gte": "gte",
      "lte": "lte"
    },
    "personFilter": "CURRENT",
    "role": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "seniority": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "startDate": {
      "gte": "gte",
      "lte": "lte"
    },
    "subrole": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    }
  }
}
'

shell

Example Request Body

{
  "company": {
    "aggkCompanyId": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "companyFilter": "WORK_EXPERIENCE",
    "companyName": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "companyType": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "companyWebsite": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "country": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "employeeCountRange": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "fundingRoundCount": {
      "max": 0,
      "min": 0
    },
    "fundingTotal": {
      "max": 0,
      "min": 0
    },
    "industry": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "latestFundingAmount": {
      "max": 0,
      "min": 0
    },
    "latestFundingDate": {
      "gte": "gte",
      "lte": "lte"
    },
    "latestFundingStage": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "locality": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "primaryExchange": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "primaryTicker": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "region": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "relationshipType": "CUSTOMER_VENDOR",
    "revenueRangeInferred": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    }
  },
  "cursor": "cursor",
  "limit": 100,
  "metadata": {
    "key": "string"
  },
  "person": {
    "aggkPersonId": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "personCountry": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "personLocality": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "personRegion": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    }
  },
  "vendorgraphics": {
    "aggkProductId": {
      "and": [
        0
      ],
      "not": [
        0
      ],
      "or": [
        0
      ]
    },
    "categoryId": {
      "and": [
        0
      ],
      "not": [
        0
      ],
      "or": [
        0
      ]
    },
    "detectionPeriodBuffer": "SIX_MONTHS",
    "filterByDetectionPeriod": true
  },
  "workExperience": {
    "currentStartDateAtCompany": {
      "gte": "gte",
      "lte": "lte"
    },
    "endDate": {
      "gte": "gte",
      "lte": "lte"
    },
    "jobTitle": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "originalStartDateAtCompany": {
      "gte": "gte",
      "lte": "lte"
    },
    "personFilter": "CURRENT",
    "role": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "seniority": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "startDate": {
      "gte": "gte",
      "lte": "lte"
    },
    "subrole": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    }
  }
}

json

Example Responses

{
  "data": [
    {
      "currentPositions": [
        {
          "aggkCompanyId": 123456789,
          "companyType": "current",
          "currentStartDateAtCompany": "2022-01",
          "jobTitle": "Software Engineer",
          "name": "AggKnowledge",
          "originalStartDateAtCompany": "2020-06",
          "totalStintsAtCompany": 2
        }
      ],
      "firstName": "daniel",
      "id": 590654273,
      "lastName": "entrup",
      "linkedinUrl": "linkedin.com/in/danielentrup",
      "matchingCompany": {
        "aggkCompanyId": 47934076,
        "currentStartDateAtCompany": "2022-01",
        "endDate": "2023-11",
        "jobTitle": "business analyst & pmo - emea chief operations officer office",
        "name": "Salesforce",
        "originalStartDateAtCompany": "2020-06",
        "role": "analyst",
        "seniority": "cxo",
        "startDate": "2023-02",
        "subrole": "data_analyst",
        "totalStintsAtCompany": 2
      },
      "matchingProduct": {
        "aggkProductId": 987654321,
        "detectionFirstSeenAt": "2024-08-25",
        "detectionLastSeenAt": "2024-08-25",
        "productName": "Ordergroove"
      },
      "personCountry": "United States",
      "personLocality": "San Francisco",
      "personRegion": "California"
    }
  ],
  "hasProblems": true,
  "isRetryable": true,
  "isSuccess": true,
  "metadata": {
    "key": "string"
  },
  "nextCursor": "nextCursor"
}

json

Count advanced discover search results

POST

https://api.aggknowledgeai.com

/v2/{environment}/discover/people/advanced/count

Returns the count of persons matching complex criteria with and/or/not semantics organized by index (vendorgraphics, company, workExperience) (Tier 2)

Count advanced discover search results › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Count advanced discover search results › Headers

x-api-key

string · required

API key for authentication

Count advanced discover search results › Request Body

Advanced discover search request

object

Filters for company index

cursor

string

Pagination cursor from previous response for fetching next page of results

limit

integer · int32

Maximum number of results to return per page (default: 100, max: 1000)

object

Caller-supplied metadata associated with the request

object

Filters for person attributes

object

Filters for vendorgraphics index

object

Filters for work experience index

Count advanced discover search results › Responses

Count of matching persons

Response containing the count of matching results

count

integer · int64

Number of matching persons for the given search criteria

hasProblems

boolean

Whether the response contains any problems

isRetryable

boolean

Whether the operation is retryable in case of failure

isSuccess

boolean

Whether the operation was successful

object

Caller-supplied metadata echoed back from the request

POST/v2/{environment}/discover/people/advanced/count

curl --request POST \
  --url https://api.aggknowledgeai.com/v2/:environment/discover/people/advanced/count \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <string>' \
  --data '
{
  "company": {
    "aggkCompanyId": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "companyFilter": "WORK_EXPERIENCE",
    "companyName": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "companyType": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "companyWebsite": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "country": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "employeeCountRange": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "fundingRoundCount": {
      "max": 0,
      "min": 0
    },
    "fundingTotal": {
      "max": 0,
      "min": 0
    },
    "industry": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "latestFundingAmount": {
      "max": 0,
      "min": 0
    },
    "latestFundingDate": {
      "gte": "gte",
      "lte": "lte"
    },
    "latestFundingStage": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "locality": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "primaryExchange": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "primaryTicker": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "region": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "relationshipType": "CUSTOMER_VENDOR",
    "revenueRangeInferred": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    }
  },
  "cursor": "cursor",
  "limit": 100,
  "metadata": {
    "key": "string"
  },
  "person": {
    "aggkPersonId": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "personCountry": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "personLocality": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "personRegion": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    }
  },
  "vendorgraphics": {
    "aggkProductId": {
      "and": [
        0
      ],
      "not": [
        0
      ],
      "or": [
        0
      ]
    },
    "categoryId": {
      "and": [
        0
      ],
      "not": [
        0
      ],
      "or": [
        0
      ]
    },
    "detectionPeriodBuffer": "SIX_MONTHS",
    "filterByDetectionPeriod": true
  },
  "workExperience": {
    "currentStartDateAtCompany": {
      "gte": "gte",
      "lte": "lte"
    },
    "endDate": {
      "gte": "gte",
      "lte": "lte"
    },
    "jobTitle": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "originalStartDateAtCompany": {
      "gte": "gte",
      "lte": "lte"
    },
    "personFilter": "CURRENT",
    "role": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "seniority": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "startDate": {
      "gte": "gte",
      "lte": "lte"
    },
    "subrole": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    }
  }
}
'

shell

Example Request Body

{
  "company": {
    "aggkCompanyId": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "companyFilter": "WORK_EXPERIENCE",
    "companyName": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "companyType": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "companyWebsite": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "country": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "employeeCountRange": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "fundingRoundCount": {
      "max": 0,
      "min": 0
    },
    "fundingTotal": {
      "max": 0,
      "min": 0
    },
    "industry": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "latestFundingAmount": {
      "max": 0,
      "min": 0
    },
    "latestFundingDate": {
      "gte": "gte",
      "lte": "lte"
    },
    "latestFundingStage": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "locality": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "primaryExchange": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "primaryTicker": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "region": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "relationshipType": "CUSTOMER_VENDOR",
    "revenueRangeInferred": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    }
  },
  "cursor": "cursor",
  "limit": 100,
  "metadata": {
    "key": "string"
  },
  "person": {
    "aggkPersonId": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "personCountry": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "personLocality": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "personRegion": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    }
  },
  "vendorgraphics": {
    "aggkProductId": {
      "and": [
        0
      ],
      "not": [
        0
      ],
      "or": [
        0
      ]
    },
    "categoryId": {
      "and": [
        0
      ],
      "not": [
        0
      ],
      "or": [
        0
      ]
    },
    "detectionPeriodBuffer": "SIX_MONTHS",
    "filterByDetectionPeriod": true
  },
  "workExperience": {
    "currentStartDateAtCompany": {
      "gte": "gte",
      "lte": "lte"
    },
    "endDate": {
      "gte": "gte",
      "lte": "lte"
    },
    "jobTitle": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "originalStartDateAtCompany": {
      "gte": "gte",
      "lte": "lte"
    },
    "personFilter": "CURRENT",
    "role": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "seniority": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "startDate": {
      "gte": "gte",
      "lte": "lte"
    },
    "subrole": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    }
  }
}

json

Example Responses

{
  "count": 0,
  "hasProblems": true,
  "isRetryable": true,
  "isSuccess": true,
  "metadata": {
    "key": "string"
  }
}

json

application/json

Validate an advanced discover request

POST

https://api.aggknowledgeai.com

/v2/{environment}/discover/people/advanced/validate

Validates all field values in an advanced discover request and returns detailed warnings for any invalid values (especially enums such as role, industry, seniority). Does not perform a search or consume credits. (Tier 2)

Validate an advanced discover request › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Validate an advanced discover request › Headers

x-api-key

string · required

API key for authentication

Validate an advanced discover request › Request Body

Advanced discover search request

object

Filters for company index

cursor

string

Pagination cursor from previous response for fetching next page of results

limit

integer · int32

Maximum number of results to return per page (default: 100, max: 1000)

object

Caller-supplied metadata associated with the request

object

Filters for person attributes

object

Filters for vendorgraphics index

object

Filters for work experience index

Validate an advanced discover request › Responses

Validation result with warnings for any invalid values

Response containing the results of request validation

isValid

boolean

Whether all provided values are valid (true when warnings is empty)

object

Caller-supplied metadata echoed back from the request

object[]

List of validation warnings, one per invalid field value

POST/v2/{environment}/discover/people/advanced/validate

curl --request POST \
  --url https://api.aggknowledgeai.com/v2/:environment/discover/people/advanced/validate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <string>' \
  --data '
{
  "company": {
    "aggkCompanyId": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "companyFilter": "WORK_EXPERIENCE",
    "companyName": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "companyType": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "companyWebsite": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "country": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "employeeCountRange": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "fundingRoundCount": {
      "max": 0,
      "min": 0
    },
    "fundingTotal": {
      "max": 0,
      "min": 0
    },
    "industry": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "latestFundingAmount": {
      "max": 0,
      "min": 0
    },
    "latestFundingDate": {
      "gte": "gte",
      "lte": "lte"
    },
    "latestFundingStage": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "locality": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "primaryExchange": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "primaryTicker": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "region": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "relationshipType": "CUSTOMER_VENDOR",
    "revenueRangeInferred": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    }
  },
  "cursor": "cursor",
  "limit": 100,
  "metadata": {
    "key": "string"
  },
  "person": {
    "aggkPersonId": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "personCountry": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "personLocality": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "personRegion": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    }
  },
  "vendorgraphics": {
    "aggkProductId": {
      "and": [
        0
      ],
      "not": [
        0
      ],
      "or": [
        0
      ]
    },
    "categoryId": {
      "and": [
        0
      ],
      "not": [
        0
      ],
      "or": [
        0
      ]
    },
    "detectionPeriodBuffer": "SIX_MONTHS",
    "filterByDetectionPeriod": true
  },
  "workExperience": {
    "currentStartDateAtCompany": {
      "gte": "gte",
      "lte": "lte"
    },
    "endDate": {
      "gte": "gte",
      "lte": "lte"
    },
    "jobTitle": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "originalStartDateAtCompany": {
      "gte": "gte",
      "lte": "lte"
    },
    "personFilter": "CURRENT",
    "role": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "seniority": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "startDate": {
      "gte": "gte",
      "lte": "lte"
    },
    "subrole": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    }
  }
}
'

shell

Example Request Body

{
  "company": {
    "aggkCompanyId": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "companyFilter": "WORK_EXPERIENCE",
    "companyName": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "companyType": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "companyWebsite": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "country": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "employeeCountRange": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "fundingRoundCount": {
      "max": 0,
      "min": 0
    },
    "fundingTotal": {
      "max": 0,
      "min": 0
    },
    "industry": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "latestFundingAmount": {
      "max": 0,
      "min": 0
    },
    "latestFundingDate": {
      "gte": "gte",
      "lte": "lte"
    },
    "latestFundingStage": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "locality": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "primaryExchange": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "primaryTicker": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "region": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "relationshipType": "CUSTOMER_VENDOR",
    "revenueRangeInferred": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    }
  },
  "cursor": "cursor",
  "limit": 100,
  "metadata": {
    "key": "string"
  },
  "person": {
    "aggkPersonId": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "personCountry": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "personLocality": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "personRegion": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    }
  },
  "vendorgraphics": {
    "aggkProductId": {
      "and": [
        0
      ],
      "not": [
        0
      ],
      "or": [
        0
      ]
    },
    "categoryId": {
      "and": [
        0
      ],
      "not": [
        0
      ],
      "or": [
        0
      ]
    },
    "detectionPeriodBuffer": "SIX_MONTHS",
    "filterByDetectionPeriod": true
  },
  "workExperience": {
    "currentStartDateAtCompany": {
      "gte": "gte",
      "lte": "lte"
    },
    "endDate": {
      "gte": "gte",
      "lte": "lte"
    },
    "jobTitle": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "originalStartDateAtCompany": {
      "gte": "gte",
      "lte": "lte"
    },
    "personFilter": "CURRENT",
    "role": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "seniority": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    },
    "startDate": {
      "gte": "gte",
      "lte": "lte"
    },
    "subrole": {
      "and": [
        "string"
      ],
      "not": [
        "string"
      ],
      "or": [
        "string"
      ]
    }
  }
}

json

Example Responses

{
  "isValid": true,
  "metadata": {
    "key": "string"
  },
  "warnings": [
    {
      "code": "code",
      "field": "field",
      "message": "message",
      "validValues": [
        "string"
      ],
      "value": "value"
    }
  ]
}

json

application/json

Discover Basic Person Vendorgraphics

Advanced Discover Search

POST

https://api.aggknowledgeai.com

/v2/{environment}/discover/people/advanced

Returns persons matching complex criteria with or/not semantics organized by index (vendorgraphics, company, workExperience) (Tier 2)

Advanced Discover Search › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Advanced Discover Search › query Parameters

format

string

Output format: 'json' (default) or 'csv'

Default: json

Advanced Discover Search › Headers

x-api-key

string · required

API key for authentication

Advanced Discover Search › Request Body

Advanced discover search request

object

Filters for company index

cursor

string

Pagination cursor from previous response for fetching next page of results

limit

integer · int32

Maximum number of results to return per page (default: 100, max: 1000)

object

Caller-supplied metadata associated with the request

object

Filters for person attributes

object

Filters for vendorgraphics index

object

Filters for work experience index

Advanced Discover Search › Responses

Advanced discover search results

Response containing search results

object[]

List of persons matching the search criteria

hasProblems

boolean

Whether the response contains any problems

isRetryable

boolean

Whether the operation is retryable in case of failure

isSuccess

boolean

Whether the operation was successful

object

Caller-supplied metadata echoed back from the request

nextCursor

string

Pagination cursor for fetching the next page of results

Count advanced discover search results

POST

https://api.aggknowledgeai.com

/v2/{environment}/discover/people/advanced/count

Returns the count of persons matching complex criteria with and/or/not semantics organized by index (vendorgraphics, company, workExperience) (Tier 2)

Count advanced discover search results › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Count advanced discover search results › Headers

x-api-key

string · required

API key for authentication

Count advanced discover search results › Request Body

Advanced discover search request

object

Filters for company index

cursor

string

Pagination cursor from previous response for fetching next page of results

limit

integer · int32

Maximum number of results to return per page (default: 100, max: 1000)

object

Caller-supplied metadata associated with the request

object

Filters for person attributes

object

Filters for vendorgraphics index

object

Filters for work experience index

Count advanced discover search results › Responses

Count of matching persons

Response containing the count of matching results

count

integer · int64

Number of matching persons for the given search criteria

hasProblems

boolean

Whether the response contains any problems

isRetryable

boolean

Whether the operation is retryable in case of failure

isSuccess

boolean

Whether the operation was successful

object

Caller-supplied metadata echoed back from the request

Validate an advanced discover request

POST

https://api.aggknowledgeai.com

/v2/{environment}/discover/people/advanced/validate

Validate an advanced discover request › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Validate an advanced discover request › Headers

x-api-key

string · required

API key for authentication

Validate an advanced discover request › Request Body

Advanced discover search request

object

Filters for company index

cursor

string

Pagination cursor from previous response for fetching next page of results

limit

integer · int32

Maximum number of results to return per page (default: 100, max: 1000)

object

Caller-supplied metadata associated with the request

object

Filters for person attributes

object

Filters for vendorgraphics index

object

Filters for work experience index

Validate an advanced discover request › Responses

Validation result with warnings for any invalid values

Response containing the results of request validation

isValid

boolean

Whether all provided values are valid (true when warnings is empty)

object

Caller-supplied metadata echoed back from the request

object[]

List of validation warnings, one per invalid field value