API Reference
  1. Klipfolio Public API
  2. /goals/{goalId}

Update a goal

put
https://api-public.klipfolio.com/v1.0-beta/goals/

Requires the api:write scope.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

A public goal asset.

const
enum
Allowed:
string
required
string
enum
required

The goal's type, determining payload shape and evaluation behavior.

Allowed:
payload
object

Goal-type-specific configuration. THRESHOLD: value, thresholdType ('ABOVE'|'BELOW'), valueType ('VALUE'|'METRIC'), notifyOptions. RANGE: lowerValue, upperValue, notifyOptions (e.g. ['CROSSED_INSIDE'] or ['CROSSED_OUTSIDE']). RECURRING_TARGET: value, recurringPeriod (e.g. 'D'|'w'|'M'), notifyOptions (e.g. ['PERIOD_END', 'VALUE_REACHED']). CUSTOM_TARGET: customGranularity, values (an array of { coordinate, value }). notifyOptions is an array of strings for every goal type that takes it, even when it holds a single option.

scopes
object

The metrics this goal applies to: { metrics: [

triggers
array of objects
triggers
Responses

Updated about 1 month ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Did this page help you?