listUploadReportRows

The rows of one upload's report in one bucket (ALL_ROWS, CREATED, MATCHED, RESTORED, MERGED_AFTER_IMPORT, DUPLICATE_ROWS, SKIPPED, FAILED): the row number, its outcome and reason, the original CSV row, and the contact or property it became. Page with limit/offset; total counts the bucket. A later step on these contacts acts on each row's contact.id, never a lookup by name (two contacts can share one).

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "listUploadReportRows",
    "variables": {
      "fileProcessingTaskId": "<fileProcessingTaskId>",
      "bucket": "ALL_ROWS"
    }
  }'

import { GoliathClient } from '@goliath-data/sdk'

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

// Enum values as strings: the SDK's enum types aren't exported yet, so assert to the method's variables type.
const variables = {
  fileProcessingTaskId: '<fileProcessingTaskId>',
  bucket: 'ALL_ROWS'
} as Parameters<typeof goliath.files.listUploadReportRows>[0]

const result = await goliath.files.listUploadReportRows(variables)

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: 'listUploadReportRows',
    variables: {
      fileProcessingTaskId: '<fileProcessingTaskId>',
      bucket: 'ALL_ROWS'
    }
  }),
})
const { data, errors } = await res.json()

limit is clamped to 100.

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

bucketUploadReportBucket!required

ALL_ROWSCREATEDMATCHEDRESTOREDMERGED_AFTER_IMPORTDUPLICATE_ROWSSKIPPEDFAILED

limitInt

Default 25.

offsetInt

Default 0.

Response

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

response shape

{
  "data": {
    "fileProcessingTaskQuery": {
      "uploadReportRows": {
        "total": 0,
        "items": [
          {
            "rowNumber": 0,
            "outcome": "CREATED",
            "outcomeReason": "…",
            "notStored": [
              "…"
            ],
            "duplicateOfRowNumber": 0,
            "csvRowJson": "…",
            "contact": {
              "id": "<ID>",
              "name": "…",
              "phoneNumbers": [
                {
                  "phoneNumber": "…"
                }
              ],
              "emails": [
                {
                  "email": "…"
                }
              ]
            },
            "property": {
              "id": "<ID>",
              "formattedAddress": "…"
            }
          }
        ]
      }
    }
  }
}

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.

curl https://server.goliathdata.com/api/v1/call \ -H "Authorization: Bearer $GOLIATH_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "operationId": "listUploadReportRows", "variables": { "fileProcessingTaskId": "<fileProcessingTaskId>", "bucket": "ALL_ROWS" } }'

import { GoliathClient } from '@goliath-data/sdk' const goliath = new GoliathClient({ apiKey: process.env.GOLIATH_API_KEY!, baseUrl: 'https://server.goliathdata.com', }) // Enum values as strings: the SDK's enum types aren't exported yet, so assert to the method's variables type. const variables = { fileProcessingTaskId: '<fileProcessingTaskId>', bucket: 'ALL_ROWS' } as Parameters<typeof goliath.files.listUploadReportRows>[0] const result = await goliath.files.listUploadReportRows(variables)

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: 'listUploadReportRows', variables: { fileProcessingTaskId: '<fileProcessingTaskId>', bucket: 'ALL_ROWS' } }), }) const { data, errors } = await res.json()

Variables

Response

Errors

Behaviour

Related