GoliathDevelopersGet an API key
Reference/Filesgenerated from the gateway manifest

exportProperties

Export properties (esIds) to a spreadsheet.

POST/api/v1/callADMINidempotent · 24 hruns as the key's owner
View as Markdown

Export properties (esIds) to a spreadsheet. Selection: ids (selectAll false), or a saved filterId with selectAll: true (every match; excludeIds leaves some out) or selectCount: N (the first N); totalCount is how many the selection holds (round up for a filter) and estimatedItemCount the same count. fileName names the file. includeStreetViewImages adds a Street View link per row. Spends export credits: the same credits as the app with no other cap (plan allowance first, then real money; checkBillingAction first), so name the count and the credits and have the person agree before a large one. Async: poll getBulkTask(bulkTaskId); the file is getExportReport(dataExportId) once it finishes. ADMIN: the key owner must currently be an org admin.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "operationId": "exportProperties",
    "variables": {
      "totalCount": 10,
      "estimatedItemCount": 10
    }
  }'
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.exportProperties(
  {
    totalCount: 10,
    estimatedItemCount: 10
  },
  { idempotencyKey: crypto.randomUUID() },
)
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',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
    operationId: 'exportProperties',
    variables: {
      totalCount: 10,
      estimatedItemCount: 10
    }
  }),
})
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.

ids[String!]
filterIdID
selectAllBoolean

Default false.

selectCountInt
excludeIds[String!]
totalCountInt!required
estimatedItemCountInt!required
fileNameString
includeStreetViewImagesBoolean

Response

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

response shape
{
  "data": {
    "exportMutation": {
      "startStandardExport": {
        "dataExportId": "<ID>",
        "bulkTaskId": "<ID>"
      }
    }
  }
}

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.

409idempotency_conflict

A request with this Idempotency-Key is still in flight.

Idempotency

Send an Idempotency-Key of 1 to 255 characters. A finished request retried with the same key replays its stored response, marked Idempotency-Replayed: true; one still in flight returns 409 idempotency_conflict. Keys expire after 24 hours. Write without fear →

READlistFilesREADgetUploadReportREADlistUploadReportRowsREADgetExportReportWRITErenameDataExportWRITEdeleteDataExport