Discover accounts | Signal docs

Discovery researches new accounts and their people for the campaign.

Paid research

Starting discovery uses credits. Run cost depends on the research and the records created. Read Credits.

Before you start

Complete the HTTP quickstart. Set LINKT_API_URL and LINKT_API_KEY.
Create a campaign. Set CAMPAIGN_ID to the returned id.
Use an API key with effective permissions for the reads and changes in this guide. See Permissions.
This procedure uses credits. Check get_me before you start.

Steps

Start discovery

Use your campaign ID. This sample requests one account and one contact per account.

curl --fail-with-body --request POST "$LINKT_API_URL/v2/runs/discovery" \
  --header "x-api-key: $LINKT_API_KEY" \
  --header "Content-Type: application/json" \
  --data "$(jq -cn --arg CAMPAIGN_ID "$CAMPAIGN_ID" '{"campaign_id":"0190a4e2-0000-7000-8000-000000000001","contacts_per_account":1,"count":1} | walk(if . == "0190a4e2-0000-7000-8000-000000000001" then $CAMPAIGN_ID else . end)')"

API reference: start_discovery

The response has status 202. Set RUN_ID to its id. Rules: Discovery.

Follow the run

curl --fail-with-body --request GET "$LINKT_API_URL/v2/runs/$RUN_ID" \
  --header "x-api-key: $LINKT_API_KEY"

API reference: get_run

Poll until a final status. Use the interval and timeout in Polling. A failed run has an error_code.

Read the results

curl --fail-with-body --request GET "$LINKT_API_URL/v2/accounts?campaign_id=$CAMPAIGN_ID&limit=5" \
  --header "x-api-key: $LINKT_API_KEY"

API reference: search_accounts

curl --fail-with-body --request GET "$LINKT_API_URL/v2/people?campaign_id=$CAMPAIGN_ID&limit=5" \
  --header "x-api-key: $LINKT_API_KEY"

API reference: search_people

Each result includes its membership in this campaign. Follow next_cursor to read more records.

Schedule discovery

To start future discovery on a schedule, send this update. Read Schedule rules.

curl --fail-with-body --request PATCH "$LINKT_API_URL/v2/campaigns/$CAMPAIGN_ID" \
  --header "x-api-key: $LINKT_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"discovery":{"count":3,"frequency":"weekly","status":"active"}}'

API reference: update_campaign

Pause future discovery with this update. Pause does not cancel a running job.

curl --fail-with-body --request PATCH "$LINKT_API_URL/v2/campaigns/$CAMPAIGN_ID" \
  --header "x-api-key: $LINKT_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"discovery":{"frequency":"weekly","status":"paused"}}'

API reference: update_campaign

Next steps

Review recordsCorrect records and set their review state.Monitor signalsFind events for the accounts in your campaign.Export dataDownload the campaign records as CSV.