GetImportReport

GET

/api/v1/t/{tenant}/ingestion/imports/{importId}/report

curl --request GET \
  --url 'https://example.com/api/v1/t/example/ingestion/imports/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/report?outcome=Filed'

Parameters

Path Parameters

tenant

required

string

Tenant slug

importId

required

string format: uuid

Query Parameters

outcome

Allowed values: Filed DuplicateSkipped Skipped Failed

cursor

string

limit

integer format: int32

Responses

200

OK

Media typeapplication/json

object

importId

required

string format: uuid

name

required

string

state

required

Allowed values: Uploading Uploaded Mapped DryRunDone Running Finished Cancelled Failed Discarded

cancelReason

required

One of:

null

null

unknown

Allowed values: ByUser StarterLostAccess ReadOnly StorageFull

failureReason

required

One of:

null

null

unknown

Allowed values: Unreadable TooManyFiles TooLarge StagingUnreadable WorkflowLost

startedBy

required

null | string format: uuid

startedAt

required

null | string format: date-time

endedAt

required

null | string format: date-time

filed

required

integer format: int32

duplicatesSkipped

required

integer format: int32

skipped

required

integer format: int32

failed

required

integer format: int32

pipelineFailed

required

integer format: int32

quarantined

required

integer format: int32

toReview

required

null | integer format: int32

toReviewCountedAt

required

null | string format: date-time

partial

required

boolean

rows

required

Array<object>

object

fileIndex

required

integer format: int32

path

required

null | string

outcome

required

Allowed values: Filed DuplicateSkipped Skipped Failed

documentId

required

null | string format: uuid

duplicate

required

One of:

null

null

object

object

documentId

required

null | string format: uuid

fileIndex

required

null | integer format: int32

path

required

null | string

conflict

required

One of:

null

null

unknown

Allowed values: Duplicate FileTooLarge TypeNotAllowed Encrypted Corrupt RatioExceeded AmbiguousFile FileNotWritable CsvRowWithoutFile CsvRowAmbiguous CsvFileTwice CsvValueInvalid

failure

required

One of:

null

null

unknown

Allowed values: NotAllowed Forbidden FileNotWritable FileAmbiguous FileNotCreated Unreadable

dropped

required

One of:

null

null

object

object

documentType

required

boolean

file

required

boolean

tags

required

integer format: int32

metadataValues

required

integer format: int32

nextCursor

required

null | string

Example

{
  "state": "Uploading",
  "cancelReason": "ByUser",
  "failureReason": "Unreadable",
  "rows": [
    {
      "outcome": "Filed",
      "conflict": "Duplicate",
      "failure": "NotAllowed"
    }
  ]
}

400

Bad Request

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

errors

object

key

additional properties

Array<string>

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

403

Forbidden

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

429

Too Many Requests

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}