GoliathDevelopersGet an API key
Reference/Library File Runsgenerated from the gateway manifest

previewLibraryFileRun

The first rows of a mapped run as it reads them.

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

The first rows of a mapped run as it reads them: for a skip trace each row's lookups (inputs: whose owner, at which address), for a tag the properties. The row count is how many rows it reads. A skip trace costs up to one credit per lookup: rows times the lookups per row. skipTrace is true for a SKIPTRACE run and false for TAG_PROPERTIES. limit is 1 to 10. Read only.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "previewLibraryFileRun",
    "variables": {
      "fileProcessingTaskId": "<fileProcessingTaskId>",
      "skipTrace": true
    }
  }'
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.libraryFileRuns.previewLibraryFileRun({
  fileProcessingTaskId: '<fileProcessingTaskId>',
  skipTrace: true
})
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: 'previewLibraryFileRun',
    variables: {
      fileProcessingTaskId: '<fileProcessingTaskId>',
      skipTrace: true
    }
  }),
})
const { data, errors } = await res.json()

limit is clamped to 10.

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
skipTraceBoolean!required
limitInt

Default 8.

Response

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

response shape
{
  "data": {
    "fileProcessingTaskQuery": {
      "skipTraceRowCount (if $skipTrace)": 0,
      "skipTraceRows (if $skipTrace)": [
        {
          "rowIndex": 0,
          "rawRowJson": "…",
          "error": "…",
          "inputs": [
            {
              "actorName": "…",
              "propertyAddress": {
                "raw": "…"
              },
              "mailingAddress": {
                "raw": "…"
              },
              "propertyEsId": "…"
            }
          ]
        }
      ],
      "tagRowCount (unless $skipTrace)": 0,
      "tagRows (unless $skipTrace)": [
        {
          "rowIndex": 0,
          "rawRowJson": "…",
          "error": "…",
          "properties": [
            {
              "address": {
                "raw": "…"
              }
            }
          ]
        }
      ]
    }
  }
}

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.

WRITEstartLibraryFileRunWRITEmapLibraryFileRunWRITEreviseLibraryFileRunWRITEconfirmLibraryFileRun