docs
Enrichment

Get a batch lookup job

GET
/v1/enrich/jobs/{id}

Returns the status and progress of a batch lookup. Free.

Authorization

bearerAuth
headerAuthorizationBearer <API key>

Create a key in the app under Developers. Keys start with dcd_live_.

Path Parameters

id*string

Enrichment job id. Starts with enr_.

Match^enr_

Response Body

Success.

application/json
  1. response

A batch enrichment job. Poll it, or subscribe to the enrichment.completed webhook.

id*string

Enrichment job id. Starts with enr_.

Match^enr_
status*string

Where the job is.

Value in"pending""running""completed""failed"
total*integer

Rows submitted.

Range0 <= value <= 9007199254740991
processed*integer

Rows looked up so far. Equals total once the job has finished.

Range0 <= value <= 9007199254740991
matched*integer

Rows matched so far.

Range0 <= value <= 9007199254740991
chips_charged*integer

Chips spent by this job so far.

Range0 <= value <= 9007199254740991
error_code*|

Why the job stopped early: 'insufficient_chips' when you ran out of chips (rows after that were not looked up), or the error that failed the job, such as 'upstream_unavailable'. Null when it ran to the end.

created_at*string

When the job was created.

Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
Formatdate-time
result_url*|

Download link for the result CSV: your rows plus the matched lead fields. Valid for 15 minutes; fetch the job again for a new one. Null until the job finishes.

request_id*string

Id of the request that produced this response. A replayed idempotent response keeps the original id.

Example Request
curl -X GET 'https://api.diced.si/v1/enrich/jobs/enr_5tYu8IoP2aSd4FgH6jKl1ZxC' \  -H 'Authorization: Bearer dcd_live_your_key'
Example Response
{  "id": "string",  "status": "pending",  "total": 0,  "processed": 0,  "matched": 0,  "chips_charged": 0,  "error_code": "unauthorized",  "created_at": "2019-08-24T14:15:22Z",  "result_url": "http://example.com",  "request_id": "string"}