GoliathDevelopersGet an API key
Reference/Propertiesgenerated from the gateway manifest

countPropertySignals

Count PUBLIC-RECORD SIGNAL EVENTS in an area, by type and publication-day window.

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

Count PUBLIC-RECORD SIGNAL EVENTS in an area, by type and publication-day window. Filings, not contacts: tagged leads are filterContacts. An event is one property's signal of one type on one day (three liens = three); standing conditions (ABSENTEE_OWNER…) are not events, and it is NOT filterProperties' total. AREA: a saved filterId OR an inline filterTree (saveFilter's PROPERTY DSL, strict: conditions and groups, never children): a county is countyFilters with its fips (searchCounties), a city cityFilters with its id (searchCities). signalTypes narrows (omit for all); from / to are inclusive YYYY-MM-DD days. Returns totalEvents, propertyCount (distinct properties with a counted event), byType, and uncountedByType / uncountedPropertyCount: properties with a type only from an open recorded filing or listing mark (no day, so no event), which filterProperties finds. Each row is what that type's byType misses (rows overlap); uncountedPropertyCount counts properties missed entirely. Never call a type absent while uncountedByType lists it. includeIncompleteRecords: true lifts the completeness gate. Spends nothing.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "countPropertySignals",
    "variables": {}
  }'
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.properties.countPropertySignals({})
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: 'countPropertySignals',
    variables: {}
  }),
})
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.

filterIdID
filterTreeJSON
signalTypes[String!]
fromString
toString
includeIncompleteRecordsBoolean
inSavedAreasBoolean

Response

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

response shape
{
  "data": {
    "filterQuery": {
      "countPropertySignals": {
        "totalEvents": 0,
        "propertyCount": 0,
        "byType": [
          {
            "signalType": "…",
            "events": 0,
            "properties": 0
          }
        ],
        "uncountedByType": [
          {
            "signalType": "…",
            "properties": 0
          }
        ],
        "uncountedPropertyCount": 0
      }
    }
  }
}

Errors

Behaviour

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