Data Import

Get import status

Get the current status of a data import job.

get/topics/{topicId}/imports/{importId}

Request

Base URL
https://api.youscan.io/api/external
Auth
- API key in header X-API-KEY
- or API key in query parameter apiKey
TypeScript
https://skmtc.dev/youscan/apis/youscan-api/docs/topics/:topicId/imports/:importId/get.ts
A function with typed inputs. Its response is checked against the schema.

topicIdinteger required

ID of the Topic.

importIdinteger required

ID of the Import.

Import status.

importIdinteger

Unique import identifier.

namestring nullable

Import name.

totalMentionsinteger

Total number of mentions in the import.

savedCountinteger

Number of successfully saved mentions.

failedCountinteger

Number of failed mentions.

status'Pending' | 'Processing' | 'Completed' | 'Failed' | 'Aborted'

Current import status.

createdAtstring date-time

Creation timestamp (ISO 8601).

startedAtstring date-time nullable

Processing start timestamp (ISO 8601).

completedAtstring date-time nullable

Completion timestamp (ISO 8601).

lastErrorstring nullable

Last error message.

sourcestring

Where the import was created from (e.g. "Api", "Ui").

userEmailstring nullable

Email of the user who created the import.

userNamestring nullable

Name of the user who created the import.

canShowMentionsboolean

Whether the imported mentions can be viewed in the topic.

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