Get list migration progress
Returns the visible import job's committed counts, generation, terminal failure and resumability. The job persists across worker restarts and page reloads.
GET
Returns the visible import job's committed counts, generation, terminal failure and resumability. The job persists across worker restarts and page reloads.
apiKeyheader
x-api-key<token>id*stringMatch
^cimport_[0-9a-hjkmnp-tv-z]{16,24}$Success
application/json- response
id*ContactImportJobIdMatch
^cimport_[0-9a-hjkmnp-tv-z]{16,24}$namespaceId*|nulltopicId*TopicIdMatch
^tpc_[0-9a-hjkmnp-tv-z]{16,24}$preset*stringValue in
"beehiiv""substack""kit""mailchimp"status*stringValue in
"queued""running""finalizing""completed""failed"generation*integerRange
0 <= value <= 9007199254740991counts*processedRows*integerRange
0 <= value <= 9007199254740991totalRows*integerRange
0 <= value <= 9007199254740991createdAt*stringstartedAt*string|nullupdatedAt*stringcompletedAt*string|nullfailure*|nullresumable*booleanimport { createClient } from "samva";
const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });
const result = await samva.contacts.getImportJob({
"id": "example"
});Example Response
{
"id": "string",
"namespaceId": "string",
"topicId": "string",
"preset": "beehiiv",
"status": "queued",
"generation": 0,
"counts": {
"totalRows": 0,
"uniqueAddresses": 0,
"subscribed": 0,
"unsubscribed": 0,
"suppressed": 0,
"skipped": 0,
"conflicts": 0,
"created": 0,
"existing": 0
},
"processedRows": 0,
"totalRows": 0,
"createdAt": "string",
"startedAt": "string",
"updatedAt": "string",
"completedAt": "string",
"failure": {
"code": "string",
"message": "string",
"retryable": true
},
"resumable": true
}