Skip to content
rigid.fi

List a programme's velocity controls

GET/v1/programs/{id}/velocity-controls

Requires an API client bearer token.

Lists the velocity (rolling-window count/amount) rules placed on this programme (scope fixed to the programme by the path). Unpaginated upstream, so this always answers `has_more: false, next_cursor: null`.

Parameters

Path parameters

NameRequiredDescription
idrequired

Example

curl https://api.rigid.fi/v1/programs/{id}/velocity-controls \
  -H "Authorization: Bearer $RIGID_API_TOKEN"

Responses

200

The programme's velocity controls.

dataarray of objectrequired
+ show properties
window"hour" | "day" | "month"required
max_countinteger
max_amountstring
idstringrequired
has_morebooleanrequired
next_cursorstring | nullrequired
400

Validation error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
401

Authentication required

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
403

Forbidden

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
404

Programme not found

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
500

Internal server error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring