Skip to main content

Partial update goal​

Update several fields of a goal

Path Parameters
  • goalId int64 required
Request Body required
  • description string
  • hasMultipleConversions boolean
  • isMainGoal boolean
  • mentalistWeight double
  • name string

    Name of goal

  • params object

    Type of params depends on 'type' field. 'CLICK' - ClickTrackingGoalParams. 'SCROLL' - ScrollTrackingGoalParams. 'URL' - AccessToPageGoalParams. 'TIME_SPENT' - TimeSpentGoalParams. 'PAGE_VIEWS' - PageViewsGoalParams. For others types params aren't needed.

  • tags string[]
  • trackingTools string[]

    Possible values: [GOOGLE_ANALYTICS4, GOOGLE_ANALYTICS4_AUDIENCES, GOOGLE_UNIVERSAL_ANALYTICS, ECONDA, SMART_TAG, PIANO, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, KISSMETRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, SMARTFOCUS, EMARSYS, EXPERTSENDER, TAG_COMMANDER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATIONS, HEAP, SEGMENT, MIXPANEL, CLARITY, IABTCF, SMARTLOOK, MOUSEFLOW, KLAVIYO, FULLSTORY, AMPLITUDE, SNOWPLOW, JUNE, MPARTICLE, BIGQUERY, RUDDERSTACK, SNOWFLAKE, GLASSBOX, HUBSPOT, AIR360, DATADOG, KAMELEOON_TRACKING, CUSTOM_TRACKING, VERCEL, AKAMAI]

  • type string

    Possible values: [CLICK, CUSTOM, SCROLL, PAGE_VIEWS, URL, TIME_SPENT, RETENTION_RATE, WAREHOUSE]

Responses

OK

Schema
  • accessLimiters object[]
  • Array [
  • accessHolder string

    Possible values: [PERSONALIZATION, AB_TEST, TAG]

  • accessHolderId int64
  • id int64
  • ]
  • createdBy int64

    Account id to whom created this experiment

  • dateCreated date-time
  • dateModified date-time
  • description string
  • experimentAmount int64

    Number of experiments using this goal. This is an optional field needs to specify in request params.

  • experiments int64[]

    List of experiment ids using this goal. This is an optional field needs to specify in request params.

  • featureFlagAmount int64

    Number of feature flags using this goal. This is an optional field needs to specify in request params.

  • hasMultipleConversions boolean
  • id int64

    Unique identifier of goal

  • isActive boolean deprecated

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

  • isTargetingSegmentMentalist boolean

    Indicates that the goal related to mentalist segment. This is an optional field needs to specify in request params.

  • mentalistWeight double
  • name string required

    Name of goal

  • params object
  • oneOf
  • matchString string
  • matchType string

    Possible values: [CONTAINS, CORRESPONDS_EXACTLY, REGULAR_EXPRESSION]

  • personalizationAmount int64

    Number of personalizations using this goal. This is an optional field needs to specify in request params.

  • personalizations int64[]

    List of personalization ids using this goal. This is an optional field needs to specify in request params.

  • siteId int64
  • status string

    Possible values: [ACTIVE, INACTIVE]

    Indicates the status of the goal: active or inactive

  • tags string[]

    List of tags using by this goal. For get requests: this is an optional field needs to specify in request params.

  • trackingTools string[]

    Possible values: [GOOGLE_ANALYTICS4, GOOGLE_ANALYTICS4_AUDIENCES, GOOGLE_UNIVERSAL_ANALYTICS, ECONDA, SMART_TAG, PIANO, ADOBE_OMNITURE, EULERIAN, WEBTRENDS, KISSMETRICS, PIWIK, CRAZY_EGG, COM_SCORE, TEALIUM, YSANCE, M_PATHY, SMARTFOCUS, EMARSYS, EXPERTSENDER, TAG_COMMANDER, CONTENT_SQUARE, WEBTREKK, CUSTOM_INTEGRATIONS, HEAP, SEGMENT, MIXPANEL, CLARITY, IABTCF, SMARTLOOK, MOUSEFLOW, KLAVIYO, FULLSTORY, AMPLITUDE, SNOWPLOW, JUNE, MPARTICLE, BIGQUERY, RUDDERSTACK, SNOWFLAKE, GLASSBOX, HUBSPOT, AIR360, DATADOG, KAMELEOON_TRACKING, CUSTOM_TRACKING, VERCEL, AKAMAI]

  • type string

    Possible values: [CLICK, CUSTOM, SCROLL, PAGE_VIEWS, URL, TIME_SPENT, RETENTION_RATE, WAREHOUSE]

    • Loading...