Definitions

Preview a definition

POST/definitions/preview

Scopegraph:readRoleCurrent member; module visibility appliesBilling1 credit per call

Estimates the reach and backfill cost of a definition before it exists. Counts and credit ranges are best-effort heuristics, not billable quotes. Takes the same body as POST /definitions.

Body

application/json

namestringrequired

moduleKeyenumrequired

entityKindsenum[]required

valueTypeenumrequired

reasonstringrequired

Why this change is being made. 1–500 characters. Stored in the audit trail.

Response

200 · application/json

entitiesInScope{ account, contact, deal, investor }

sourcesToBackfillinteger

estCreditsPerSourcenumber

estBackfillCredits{ low, high }

conflictingFlatLabels{ name, slug, assignments }[]

curl --fail-with-body "https://app.ghostgtm.ai/api/v1/definitions/preview" \ -H "Authorization: Bearer $GHOST_API_KEY" \ -H "Content-Type: application/json" \ --data '{ "name": "Integration stage", "moduleKey": "customers", "entityKinds": [ "account" ], "valueType": "enum", "enumValues": [ { "label": "New" }, { "label": "Qualified" } ], "reason": "Sizing before we create it" }'

{ "entitiesInScope": { "account": 312, "contact": 0, "deal": 0, "investor": 0 }, "sourcesToBackfill": 1840, "estCreditsPerSource": 0.02, "estBackfillCredits": { "low": 29, "high": 44 }, "conflictingFlatLabels": [ { "name": "Qualified", "slug": "qualified", "assignments": 27 } ] }