Sign in

v1

latestOpenAPI 3.0.32026-07-22177397578.0 KB
Goal

Update goal

Update goal with given id

put/goals/{goalId}

Path parameters

goalIdinteger required

Request body

createdByinteger

Account Id of the creator of the experiment

dateCreatedstring date-time
dateModifiedstring date-time
descriptionstring
experimentAmountinteger

Number of experiments using this goal. This is an optional field that that is included in the request body

experimentsinteger[]

List of experiment ids using this goal. This is an optional field that is included in the request body

featureFlagAmountinteger

Number of feature flags using this goal. This is an optional field that that is included in the request body

hasMultipleConversionsboolean required

Indicates if this goal has multiple conversions

holdoutAmountinteger

Number of holdouts using this goal. This is an optional field that is included in the request body

holdoutsinteger[]

List of holdout ids using this goal. This is an optional field that is included in the request body

idinteger

Unique Id of the goal

isActiveboolean

Deprecated. Use status instead. Indicates the status of the goal: active or not

isTargetingSegmentMentalistboolean

Indicates if the goal is related to a mentalist segment. This is an optional field that is included in the request body

mentalistWeightnumber double
namestring required

Name of the goal

personalizationAmountinteger

Number of personalizations using this goal. This is an optional field that is included in the request body

personalizationsinteger[]

List of personalization ids using this goal. This is an optional field that is included in the request body

siteIdinteger required

Site Id of the project that the goal belongs to

status'ACTIVE' | 'INACTIVE'

Indicates the status of the goal: active or inactive

tagsstring[]

List of tags belonging to this goal. For GET requests: this is an optional field that has to be specified in request params.

targetingSegmentMentalistinteger[]
trackingToolsstring[]
type'CLICK' | 'CUSTOM' | 'SCROLL' | 'PAGE_VIEWS' | 'URL' | 'TIME_SPENT' | 'RETENTION_RATE' | 'WAREHOUSE' | 'RATIO_METRICS' required

Type of goal

Response

OK