Skip to main content

Create a new goal

POST 
/goals

Create new goal with given parameters

Request​

Body

required

    accessLimiters

    object[]

  • Array [

    • accessHolder string

    Possible values: [PERSONALIZATION, AB_TEST, TAG]

    accessHolderId int64
    id int64

  • ]

    • customDatas

    object[]

    List of custom data using this goal

  • Array [

    • adobeAnalyticsVariableName string

    Variable name of the Adobe Analytics

    advancedProposedValues string

    Enables to set values for targeting conditions in the form of a JS table

    customEvalCode string

    Custom code that will be executed

    description string

    Description of the custom data

    format string

    Custom data value format

    Possible values: [BOOLEAN, NUMBER, STRING]

    gtmVariableName string

    Variable name of the Google Tag Manager

    isConstant boolean

    Indicates if the custom data is a constant

    isFiltrableVentilable boolean

    Indicates if custom data should be filtered and marked as available for breakdown

    isLearnable boolean

    Indicates if this data should be included in Kameleoon machine learning

    isLocalOnly boolean

    Indicates if the custom data is only stored on the user's device.

    method stringrequired

    Method through which a custom data will be transmitted

    Possible values: [ADOBE_ANALYTICS, CLIENT, CUSTOM_CODE, GTM, SDK, TC, TEALIUM]

    name stringrequired

    Name of the custom data

    siteId int64required

    Id of the project this record belongs

    tags string

    Tags that belong to this record

    tcVariableName string

    Name of the tag commander data layer, if it is selected as a transmission method

    tealiumVariableName string

    Name of the Tealium, if it is selected as a transmission method

    type string

    Custom data type. Custom data can be presented as a single value (UNIQUE), or a list of values (LIST), ​​or a countable list of values (COUNT_LIST)

    Possible values: [COUNT_LIST, LIST, UNIQUE]

  • ]

    • description string
    hasMultipleConversions booleanrequired

    Indicates if this goal has multiple conversions

    mentalistWeight double
    name stringrequired

    Name of the goal

    params

    object

    oneOf

    matchString string
    matchType string

    Possible values: [CONTAINS, CORRESPONDS_EXACTLY, REGULAR_EXPRESSION]

    siteId int64required

    Site Id of the project that the goal belongs to

    status string

    Indicates the status of the goal: active or inactive

    Possible values: [ACTIVE, INACTIVE]

    tags string[]

    List of tags belonging to this goal. For GET requests: this is an optional field that has to be specified 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, DATABRICKS, REDSHIFT, SMARTLOOK, MOUSEFLOW, KLAVIYO, FULLSTORY, AMPLITUDE, SNOWPLOW, JUNE, MPARTICLE, BIGQUERY, RUDDERSTACK, SNOWFLAKE, GLASSBOX, HUBSPOT, AIR360, DATADOG, QUANTUM_METRIC, GLASSBOX_V2, KAMELEOON_TRACKING, CUSTOM_TRACKING, VERCEL, AKAMAI]

    type stringrequired

    Type of goal

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

Responses​

Created

Schema

    accessLimiters

    object[]

  • Array [

    • accessHolder string

    Possible values: [PERSONALIZATION, AB_TEST, TAG]

    accessHolderId int64
    id int64

  • ]

    • createdBy int64

    Account Id of the creator of the experiment

    customDatas

    object[]

    List of custom data using this goal

  • Array [

    • adobeAnalyticsVariableName string

    Variable name of the Adobe Analytics

    advancedProposedValues string

    Enables to set values for targeting conditions in the form of a JS table

    createdById int64

    Account Id of the creator of the custom data

    customEvalCode string

    Custom code that will be executed

    dateCreated date-time

    Date and time a record is created

    description string

    Description of the custom data

    format string

    Custom data value format

    Possible values: [BOOLEAN, NUMBER, STRING]

    gtmVariableName string

    Variable name of the Google Tag Manager

    id int64

    Unique Id of the custom data.

    index int32
    isConstant boolean

    Indicates if the custom data is a constant

    isFiltrableVentilable boolean

    Indicates if custom data should be filtered and marked as available for breakdown

    isLearnable boolean

    Indicates if this data should be included in Kameleoon machine learning

    isLocalOnly boolean

    Indicates if the custom data is only stored on the user's device.

    method stringrequired

    Method through which a custom data will be transmitted

    Possible values: [ADOBE_ANALYTICS, CLIENT, CUSTOM_CODE, GTM, SDK, TC, TEALIUM]

    modificationDate date-time

    Date and time a record is modified

    name stringrequired

    Name of the custom data

    siteCode string

    System generated unique code to identify a website.
    This is an optional field that is included in the request body

    siteId int64required

    Id of the project this record belongs

    tags string

    Tags that belong to this record

    tcVariableName string

    Name of the tag commander data layer, if it is selected as a transmission method

    tealiumVariableName string

    Name of the Tealium, if it is selected as a transmission method

    type string

    Custom data type. Custom data can be presented as a single value (UNIQUE), or a list of values (LIST), ​​or a countable list of values (COUNT_LIST)

    Possible values: [COUNT_LIST, LIST, UNIQUE]

  • ]

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

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

    experiments int64[]

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

    featureFlagAmount int64

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

    hasMultipleConversions booleanrequired

    Indicates if this goal has multiple conversions

    holdoutAmount int64

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

    holdouts int64[]

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

    id int64

    Unique Id of the goal

    isActive booleandeprecated

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

    isTargetingSegmentMentalist boolean

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

    mentalistWeight double
    name stringrequired

    Name of the 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 that is included in the request body

    personalizations int64[]

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

    siteId int64required

    Site Id of the project that the goal belongs to

    status string

    Indicates the status of the goal: active or inactive

    Possible values: [ACTIVE, INACTIVE]

    tags string[]

    List of tags belonging to this goal. For GET requests: this is an optional field that has to be specified 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, DATABRICKS, REDSHIFT, SMARTLOOK, MOUSEFLOW, KLAVIYO, FULLSTORY, AMPLITUDE, SNOWPLOW, JUNE, MPARTICLE, BIGQUERY, RUDDERSTACK, SNOWFLAKE, GLASSBOX, HUBSPOT, AIR360, DATADOG, QUANTUM_METRIC, GLASSBOX_V2, KAMELEOON_TRACKING, CUSTOM_TRACKING, VERCEL, AKAMAI]

    type stringrequired

    Type of goal

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

Loading...