Lead Finder

Get a Lead Finder import

Returns one import's progress: how many people were added and skipped and why, what verification said, and the credits spent so far. Status is running, completed, failed or canceled, and added, creditsSpent and status can still change until finishedAt is set. A completed import's endReason is all_selected, requested_reached, audience_exhausted or fetch_limit; a canceled one's is canceled. A failed import has no endReason but can still have added and charged people: lastError says why it stopped (insufficient_credits, contact_cap_reached, results_expired, budget_exhausted, provider_blocked, invalid_filters, campaign_not_found or internal). A new first_n import to finish a partial one starts from the top again and counts the people already added toward its fetch limit, so it only reaches new people while those fit inside five times its count (at least 1,000); otherwise pick the missing people by ref from search results. Imports belonging to other workspaces are reported as not found.

get/lead-finder/imports/{id}

Request

  • Base URL: https://api.emailchaser.com/r
  • URL: https://api.emailchaser.com/r/lead-finder/imports/{id}
  • Auth: HTTP bearer

Path parameters

idinteger required

Import ID (importId)

Response

The import

addedinteger
audienceKeystring

AudienceKey names the filters the people came from, as on a search.

campaignIdinteger
campaignNamestring
createdAtstring
creditsPerProspectinteger
creditsSpentinteger

CreditsSpent is what the import has charged so far. People added while the workspace's credits were free add nothing to it.

endReasonstring

EndReason says how an import ended: all_selected or requested_reached (finished), audience_exhausted or fetch_limit (a first_n import stopped early), or canceled. A failed import has none; see LastError.

expiredinteger
finishedAtstring
importIdinteger
lastErrorstring

LastError says why a failed import stopped: insufficient_credits, contact_cap_reached, results_expired, budget_exhausted, provider_blocked, provider_unavailable (the people database was down or in maintenance; start the import again later), rate_limited, invalid_filters, campaign_not_found or internal. A failed import can still have added and charged people.

modestring
requestedinteger
skipReasonsobject

SkipReasons counts skipped people by reason: already_in_workspace, blocklisted, reveal_returned_no_address, consumer_mailbox, invalid_email or contact_cap_reached.

skippedinteger
startsAtinteger

StartsAt is the position in the results a first_n import started from.

statusstring

Status is running, completed, failed or canceled. Added, CreditsSpent and Status can still change until FinishedAt is set.

topUpOfinteger

TopUpOf is set on an import a saved search's weekly top-up started (set up in the app): the saved search's id.

verifyEmailsboolean

Example response

{
  "added": 22,
  "campaignId": 123,
  "campaignName": "Irish sales leaders",
  "creditsPerProspect": 1,
  "creditsSpent": 22,
  "importId": 8812,
  "mode": "selected",
  "requested": 25,
  "skipped": 3,
  "startsAt": 201,
  "status": "completed",
  "verification": {
    "catchAll": 2,
    "invalid": 1,
    "valid": 20
  },
  "verifyEmails": true
}

Changes

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