v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB
Insights

List Profile Insights

Returns profile insights

get/api/v2/insights/profile-insights

Query parameters

limitinteger

Specifies the number of entries to be returned for the page

distributionFieldsLimitinteger

Specifies the count of top values of a particular field

positionMatchedForstring

Eightfold position ID for candidates to match

filterQuerystring

filter query using predefined candidate field query parameters documented here

querystring

any wildcard text to search in candidate data

fieldsstring

comma separated list of fields to get distributions for

excludestring

Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

keyListstring

Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

Headers

Authorizationstring required

The secret key to access the api. It starts with the bearer token

Response

OK

resultCountinteger nullable

Number of Results