scout

Preview Web Run

What a run with this campaign + brief would search for, and what it would reserve. No spend, no run row, no provider call.

post/api/v1/scout/runs/preview

Request

  • Base URL: https://api.nudgelink.co (the document declares no server; this is the origin it was published from)
  • URL: https://api.nudgelink.co/api/v1/scout/runs/preview
  • Auth: HTTP bearer

Request body

target_limitinteger
score_thresholdinteger
extra_keywordsstring[] nullable
deep_searchboolean
work_keywordsstring[]
work_keywords_mode'and' | 'or'
company_sizesstring[]
filter_labelsobject
campaign_idstring uuid nullable
find_moreboolean

Response

Successful Response

people_queriesstring[] required
company_queriesstring[] required
reserved_creditsinteger required
max_peopleinteger required
people_after_companiesboolean

Changes

No recorded changes to this operation across all 1 revision of this API.