Skip to main content
GET
Get a discovery job’s quality summary

Authorizations

Authorization
string
header
required

An Enrik API key, sent as Authorization: Bearer <key>. A key reaches public operations only, and only those whose scopes it holds. A few parameters need a scope beyond their operation’s, which the parameter names. The scopes:

  • setup:read: Read the workspace setup and its company profile.
  • setup:run: Change the setup: confirm the company profile, authorize sponsored drafting and background company research, choose what to set up and complete setup.
  • workspace:read: Read the workspace’s own profile: its health summary and setup state.
  • crm:read: Read companies with their signals, contacts and the saved views over them.
  • crm:write: Create, update and restore companies and contacts, and create, update and delete saved views.
  • crm:delete: Delete companies and contacts.
  • twin:read: Read the Company Twin: structured company knowledge and its signals.
  • discovery:read: Read ICP profiles, ICP assessments, discovery briefs, discovery jobs, candidates and the signal library.
  • discovery:write: Create and change ICP profiles, discovery briefs and signal-definition drafts, and review discovery candidates.
  • discovery:run: Create, start and cancel discovery jobs, and edit a draft one. Uses provider budget.
  • enrichment:read: Read the enrichment configuration and its results, including a record’s enrichment, formula and custom-API cells.
  • enrichment:run: Launch and cancel enrichment. Spends enrichment credits.
  • automation:read: Read workflows and agents with their run history, including a record’s agent cells.
  • automation:run: Run existing workflows and agents.
  • exports:read: Read export jobs and the fields an export can carry.
  • exports:run: Create, preview, start, cancel and archive CSV exports of companies, contacts and candidates, and download the file. Also needs crm:read. Delivering an export to a webhook destination stays in the app.
  • integrations:read: Read connections, field mappings, CRM sync jobs and webhook destinations.
  • webhooks:read: Read webhook subscriptions, the event types they can name and their delivery log.
  • webhooks:write: Subscribe a receiver URL to webhook events; edit, test, pause, resume and archive a subscription and rotate its signing secret; redeliver an event. Only workspace owners and admins can grant it.
  • reporting:read: Read analytics and dashboards.
  • assistant:read: Read the Assistant: its threads, messages and pending approvals.
  • assistant:run: Converse with the Assistant. Uses the workspace’s AI quota.
  • assistant:write: Approve or reject the changes the Assistant proposes.

Headers

If-None-Match
string

The ETag of an answer you kept. While the answer is still the same, the API answers 304 Not Modified with no body. Several tags, separated by commas, a weak tag (W/"…") and * are accepted.

Path Parameters

jobId
string<uuid>
required

The discovery job’s id.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Response

How good a discovery job’s candidates are, computed when asked.

How good a discovery job’s candidates are, computed when asked.

discoveryJobId
string
required

The discovery job summarised.

total
integer
required

How many candidates the job has.

Required range: -9007199254740991 <= x <= 9007199254740991
tierCounts
object
required

The candidates in each review-priority band.

scoredCount
integer
required

How many candidates are scored.

Required range: -9007199254740991 <= x <= 9007199254740991
verifiedDomainCount
integer
required

How many candidates have a verified website.

Required range: -9007199254740991 <= x <= 9007199254740991
duplicateCount
integer
required

How many candidates duplicate something already known.

Required range: -9007199254740991 <= x <= 9007199254740991
promotedCount
integer
required

How many candidates were promoted to companies.

Required range: -9007199254740991 <= x <= 9007199254740991
promotableCount
integer
required

How many candidates could still be promoted.

Required range: -9007199254740991 <= x <= 9007199254740991
averageReviewPriorityScore
number | null
required

The average review priority of the scored candidates; null when none is.

averageIcpFitScore
number | null
required

The average ICP fit of the scored candidates; null when none is.

averageEvidenceScore
number | null
required

The average evidence score of the scored candidates; null when none is.

label
enum<string>
required

A one-word verdict on the source’s quality.

Available options:
excellent,
good,
mixed,
low_quality,
insufficient_data