Csv
/csv-imports/previews/{id}
Get CSV preview status.
Required scope: integrations:import
Authorization
apiKey X-API-Key<token>
API key provided in dashboard
In: header
Path Parameters
id*string
Match
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Format
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.vrplatform.app/csv-imports/previews/497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": "queued",
"result": {
"logicalRecordCount": 1000000,
"stateCounts": {
"valid": 9007199254740991,
"invalid": 9007199254740991,
"unresolved": 9007199254740991,
"excluded": 9007199254740991
},
"issueCounts": {
"property1": 9007199254740991,
"property2": 9007199254740991
},
"fileHash": "string",
"planHash": "string",
"details": {
"canImport": true,
"columns": [
"string"
],
"issues": [
{
"code": "accountNotFound",
"field": "string",
"rowNumber": 1,
"message": "string"
}
],
"issueCounts": {
"property1": 9007199254740991,
"property2": 9007199254740991
},
"logicalRecordCount": 1000000,
"resolutionCounts": {
"matched": 9007199254740991,
"unmatched": 9007199254740991,
"ambiguous": 9007199254740991
},
"fileHash": "string",
"resource": "bankRecords",
"mapping": {
"resource": "bankRecords",
"version": 1,
"delimiter": ",",
"headerRow": 1,
"excludedRows": [
1
],
"date": {
"source": "string",
"format": "yyyy-mm-dd"
},
"description": {
"sources": [
"string"
],
"operation": "join"
},
"amount": {
"mode": "signed",
"source": "string",
"debit": "string",
"credit": "string",
"debitSign": -1,
"creditSign": 1
}
},
"totals": {
"rows": 9007199254740991,
"valid": 9007199254740991,
"invalid": 9007199254740991,
"excluded": 9007199254740991,
"moneyIn": -9007199254740991,
"moneyOut": -9007199254740991,
"net": -9007199254740991
}
}
},
"failure": {
"code": "csvBlankHeader",
"message": "CSV contains a blank header"
}
}{
"code": "AUDIT_CURSOR_EXPIRED",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "AUDIT_CURSOR_EXPIRED",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "AUDIT_CURSOR_EXPIRED",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "NOT_FOUND",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": {
"reason": "previewNotFound"
}
}{
"code": "AUDIT_CURSOR_EXPIRED",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "GONE",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": {
"reason": "previewExpired"
}
}{
"code": "AUDIT_CURSOR_EXPIRED",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "MISDIRECTED_REQUEST",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": {
"teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec",
"dataRegion": "ap",
"apiBaseUrl": "http://example.com"
}
}{
"code": "AUDIT_CURSOR_EXPIRED",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "AUDIT_CURSOR_EXPIRED",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "AUDIT_CURSOR_EXPIRED",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}