findContactDataProblems
Contact data problems in ONE call, never contact by contact.
Contact data problems in ONE call, never contact by contact: EMAIL_NOT_LOWERCASE, NAME_EMPTY, NAME_ONE_WORD (a first or last name missing; which is unknown), PHONE_NOT_NORMALIZED (not the 10-digit form phones are stored in; well-formed numbers are shown formatted, never stored so). Each: count of contacts you see, a sample (sampleSize ≤25) with the bad value, truncated. Pass problem for up to 500 of its contact ids past offset, what lowercaseContactEmails takes.
curl https://server.goliathdata.com/api/v1/call \
-H "Authorization: Bearer $GOLIATH_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"operationId": "findContactDataProblems",
"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.contacts.findContactDataProblems({})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: 'findContactDataProblems',
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.
A data-shape problem the contact hygiene read groups contacts by. EMAIL_NOT_LOWERCASE: An email holding a capital letter. NAME_EMPTY: No name at all. NAME_ONE_WORD: A one-word name: a first or a last name is missing (the name is one field, so which is not known). PHONE_NOT_NORMALIZED: A stored phone that is not the 10-digit US form every phone write normalizes to.
Default 0.
Response
What comes back under data: a list shows as one entry, and a value as its type.
{
"data": {
"contactQuery": {
"contactDataProblems": {
"problems": [
{
"problem": "EMAIL_NOT_LOWERCASE",
"count": 0,
"truncated": true,
"contacts": [
{
"id": "<ID>",
"name": "…",
"value": "…"
}
]
}
]
}
}
}
}Errors
unknown_variableA variable the operation does not declare. A typo is refused rather than silently dropped.
unauthorizedNo bearer header, or the key is invalid or revoked.
insufficient_scopeThe key lacks the scope the operation requires.
forbiddenA 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.