Get Address Set Import

GET

API for retrieving a single CSV import job. Use it to check the progress (processedCount / totalCount) and status (PENDING, IN_PROGRESS, DONE, FAILED) of a long-running import. Check the start and end times with startedAt and finishedAt.totalCount already holds its final value in the 202 response; only processedCount and addedCount are updated while loading. If the import ends as FAILED, the set is left empty.

Path Parameters

addressSetIdstringrequired

Parameter that specifies the addressSetId assigned to the Address Set. Use the addressSetId returned when the Address Set was created. It is a 19-digit number but is returned as a string in JSON. Parsing it as a number in JavaScript or similar environments loses precision, so always handle it as a string.

importIdintegerrequired

Parameter that specifies the importId returned when the CSV import was requested. The importId is an integer that increments sequentially from 1.

Responses

importIdintegerrequired

Field indicating the importId assigned to the import job. An integer that increments sequentially from 1; used to check the import progress.

statusstringrequired

Field indicating the status of the import job. PENDING means accepted and waiting to load, IN_PROGRESS means loading, DONE means completed, and FAILED means failed. When an import ends as FAILED, the set is left empty.

totalCountintegerrequired

Number of address lines in the uploaded CSV file. The final value is already present in the 202 response and does not change while loading.

processedCountintegerrequired

Number of address lines processed so far. Updated while loading; compare with totalCount to calculate progress.

addedCountintegerrequired

Number of distinct addresses stored in the set. Updated while loading; smaller than totalCount when the file contains the same address more than once.

errorMessagestring or nullrequired

Indicates the failure reason when the import status is FAILED. When the import failed on a line that is not an address of the set's addressFormat, it contains information about that line. Otherwise null.

createdAtstringrequired

Indicates when the import request was accepted. This field is returned in ISO 8601 format.

startedAtstring or nullrequired

Indicates when loading started. null while the status is PENDING. This field is returned in ISO 8601 format.

finishedAtstring or nullrequired

Indicates when the import ended as DONE or FAILED. null while in progress. This field is returned in ISO 8601 format.

codestringrequired

Code identifying the cause of the failed request.

messagestringrequired

Detailed message including the name and value of the invalid parameter.

{
  "code": "MISSING_REQUIRED_PARAMETER",
  "message": "Missing required parameter: { PARAMETER_NAME }"
}

X-API-KEY

cURL

curl -X GET 'https://web3.nodit.io/v1/webhook/address-sets/1788439512345678901/imports/42' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: nodit-demo'