Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Analytics

Delete a goal's completions

Deletes the completions of a goal in the period, for good. The period is required: all deletes every completion. Troopy keeps how the goal shows.

delete/api/v1/analytics/goals/{name}

Authorization

HeaderAuthorization: Bearer <API key>
Or the headerX-API-Key: <API key>
API keyMake one in Troopy under Settings > API keys. It acts as you, in its workspace.

Other ways to call it

CLItroopy analytics goals delete
MCP toolNone. Call it over REST or with the CLI.
Rate limit10 calls in 60 seconds, for each key
RetriesSend an Idempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.

Path parameters

name*string

Lowercase letters, digits, _ - and :

Query parameters

fromstring

YYYY-MM-DD, in the workspace's time zone

date

tostring

YYYY-MM-DD. The period includes this day

date

period*enum<string>

Required: all for every completion

nowtodayyesterday24h7d30d3m6m12mweekmonthyearallcustom

Response

200 · application/json
data*object
1 properties
deleted*integer

Completions deleted

Errors

400 invalid_inputFix the field named in detail. Each operation's schema is in /api/v1/openapi.json.
401 unauthorizedSend an API key as `Authorization: Bearer tr_live_...`. Create one in Troopy under Settings.
403 forbiddenThe key lacks a scope this operation needs, or its owner lacks the role. detail says which; create a key with the scope, or ask an organization owner or admin.
404 not_foundCheck the path and any id in it. Every operation is listed in /api/v1/openapi.json.
409 conflictThis Idempotency-Key was used for a different request, or that request is still running. Use a new key for a new request.
429 rate_limitedWait the number of seconds in Retry-After, then retry.