GoliathDevelopersGet an API key
Reference/Filesgenerated from the gateway manifest

getUploadReport

One upload's report.

POST/api/v1/callREADreadruns as the key's owner
View as Markdown

One upload's report: what its report sheet shows: rows in the file, how many contacts or properties it created, matched to existing records, restored, merged, skipped, failed or duplicated, and its skip-trace outcome and spend. Needs to be the uploader or able to see all contacts. Read the rows behind a count with listUploadReportRows.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "getUploadReport",
    "variables": {
      "fileProcessingTaskId": "<fileProcessingTaskId>"
    }
  }'
import { GoliathClient } from '@goliath-data/sdk'

const goliath = new GoliathClient({
  apiKey: process.env.GOLIATH_API_KEY!,
  baseUrl: 'https://server.goliathdata.com',
})

const result = await goliath.files.getUploadReport({
  fileProcessingTaskId: '<fileProcessingTaskId>'
})
const res = await fetch('https://server.goliathdata.com/api/v1/call', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.GOLIATH_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    operationId: 'getUploadReport',
    variables: {
      fileProcessingTaskId: '<fileProcessingTaskId>'
    }
  }),
})
const { data, errors } = await res.json()

Variables

The example sends only what the schema requires. Some operations also need one of several optional variables (one filter or another, say); the description above says which.

fileProcessingTaskIdID!required

Response

What comes back under data: a list shows as one entry, and a value as its type.

response shape
{
  "data": {
    "fileProcessingTaskQuery": {
      "fileProcessingTask": {
        "id": "<ID>",
        "type": "PROPERTIES",
        "status": "CREATED",
        "totalRows": 0,
        "producedRecordsCount": 0,
        "createdAt": "2026-01-01T00:00:00.000Z",
        "file": {
          "id": "<ID>",
          "fileName": "…"
        }
      },
      "uploadReport": {
        "totalRows": 0,
        "createdCount": 0,
        "matchedCount": 0,
        "restoredCount": 0,
        "skippedCount": 0,
        "failedCount": 0,
        "mergedAfterImportCount": 0,
        "duplicateRowCount": 0,
        "distinctContactsCount": 0,
        "distinctPropertiesCount": 0,
        "processedRowCount": 0,
        "hasOutcomeTracking": true,
        "skiptrace": {
          "wasBilled": true,
          "netSpent": 0,
          "found": 0,
          "foundNothing": 0,
          "failed": 0,
          "notRunYet": 0,
          "notTraced": 0
        }
      }
    }
  }
}

Errors

400unknown_variable

A variable the operation does not declare. A typo is refused rather than silently dropped.

401unauthorized

No bearer header, or the key is invalid or revoked.

403insufficient_scope

The key lacks the scope the operation requires.

403forbidden

A referenced record does not exist, was deleted, or is outside your organization. The gateway cannot tell those apart.

Behaviour

A read. It rejects an Idempotency-Key header with 400 bad_request.

READlistFilesREADlistUploadReportRowsREADgetExportReportWRITErenameDataExportWRITEdeleteDataExportWRITEdeletePendingUpload