Skip to the page

Praecise Platform

Rivier/ Reference/ analytics

Run the retention schedule now

post/analytics/site/retention/run

Run the retention schedule now: remove what has outlived it and record the evidence.

Before you call

Credential: Authorization: Bearer $KEY
Scope: analytics:write
Graphql: Mutation.analyticsSiteRetentionRun
Sdk: analytics.siteRetention.run
Cli: analytics site retention run

Request bodyapplication/json, required

dryRunboolean

Responses

200application/json
Success
object
400application/json
The request was malformed
- errorstringrequired
- messagestring
401application/json
No valid credential
- errorstringrequired
- messagestring
403application/json
The credential lacks the scope, origin or address
- errorstringrequired
- messagestring
429application/json
Over the key's rate limit; see Retry-After
- errorstringrequired
- messagestring

Example request

curl -X POST 'https://api.rivier.ai/analytics/site/retention/run' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "dryRun": false
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown