Skip to content

Property

GET /v2/property/overview returns the property the bearer token is bound to. It checks no scope, so it answers any valid token: API or MCP, any scope set. Use it as a connectivity check before anything else.

MethodPathScope
GET/v2/property/overviewnone
Terminal window
curl https://api.snipform.io/v2/property/overview \
-H "Authorization: Bearer YOUR_TOKEN"
{
"code": 200,
"status": "OK",
"data": {
"id": "64f1c2a9e4b0a1b2c3d4e5f6",
"name": "acme.com",
"domain": "acme.com",
"has_signals": true,
"state": "active",
"state_name": "Active",
"counts": {
"sessions": 48211,
"forms": 3,
"pages": 1
}
}
}
KeyTypeMeaning
idstringThe property id. Same value the dashboard shows in its URLs and the MCP endpoint uses in /mcp/{property}
namestringDisplay name. Often equals the domain
domainstringThe registered base domain. The tracker and forms only accept requests whose referrer matches it
has_signalsbooltrue once the tracker has recorded at least one session. Until then every analytics endpoint answers 404
statestringactive, inactive or archived
state_namestringHuman label for state: Active, Inactive, Archived
counts.sessionsintTotal sessions recorded to date
counts.formsintForms on the property
counts.pagesintSnipContent pages on the property

counts are lifetime counters maintained as data arrives, not a live query. For windowed numbers use Signals analytics.

HTTPMeaning
401Token missing, invalid, expired or revoked
403Token is not scoped to a property. The token was not issued from a property’s API page
404Token property no longer exists. The property was deleted after the token was created