Create new goal

POST 
/goals

Create new goal with given parameters

Request

application/json

Body

required

accessLimiters

object[]

Array [

accessHolder string

Possible values: [PERSONALIZATION, AB_TEST, TAG]

accessHolderId int64

id int64

]

description string
hasMultipleConversions booleanrequired

Does this goal have multiple conversions

mentalistWeight double
name stringrequired

Name of goal

params

object

oneOf

AccessToPageGoalParams

matchString string

matchType string

Possible values: [CONTAINS, CORRESPONDS_EXACTLY, REGULAR_EXPRESSION]

ClickTrackingGoalParams

customSelectors

object[]

Selection with a CSS selector. CSS selector to track the corresponding element

Array [

id int64

mode string

Possible values: [ID, CLASS, TAG, TAG_CLASS, CUSTOM, AUTOGENERATED, CONTENT, CUSTOM_ATTRIBUTE]

selector string

]

url string

URL of the page on which you want to create your click tracker. Example: www.mozilla.org

PageViewsGoalParams

numberMatchType string

Possible values: [MORE_THAN, EQUALS, LESS_THAN]

numberOfVisitedPages int32

ScrollTrackingGoalParams

type string

When the user scrolls down to

Possible values: [ELEMENT, PERCENTAGE, PIXELS_HEIGHT]

url string

value double

Scroll tracking value

TimeSpentGoalParams

matchType string

Possible values: [MORE_THAN, EQUALS, LESS_THAN]

timeSeconds int32
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 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, REDSHIFT, SMARTLOOK, MOUSEFLOW, KLAVIYO, FULLSTORY, AMPLITUDE, SNOWPLOW, JUNE, MPARTICLE, BIGQUERY, RUDDERSTACK, SNOWFLAKE, GLASSBOX, HUBSPOT, AIR360, DATADOG, QUANTUM_METRIC, KAMELEOON_TRACKING, CUSTOM_TRACKING, VERCEL, AKAMAI]

type stringrequired

Type of the goal

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

Responses

201

Created

*/*

Schema

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 booleanrequired

Does this goal have multiple conversions

id int64

Unique identifier of goal

isActive booleandeprecated

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 stringrequired

Name of goal

params

object

oneOf

AccessToPageGoalParams

matchString string

matchType string

Possible values: [CONTAINS, CORRESPONDS_EXACTLY, REGULAR_EXPRESSION]

ClickTrackingGoalParams

customSelectors

object[]

Selection with a CSS selector. CSS selector to track the corresponding element

Array [

id int64

mode string

Possible values: [ID, CLASS, TAG, TAG_CLASS, CUSTOM, AUTOGENERATED, CONTENT, CUSTOM_ATTRIBUTE]

selector string

]

url string

URL of the page on which you want to create your click tracker. Example: www.mozilla.org

PageViewsGoalParams

numberMatchType string

Possible values: [MORE_THAN, EQUALS, LESS_THAN]

numberOfVisitedPages int32

ScrollTrackingGoalParams

type string

When the user scrolls down to

Possible values: [ELEMENT, PERCENTAGE, PIXELS_HEIGHT]

url string

value double

Scroll tracking value

TimeSpentGoalParams

matchType string

Possible values: [MORE_THAN, EQUALS, LESS_THAN]

timeSeconds int32
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 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 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, REDSHIFT, SMARTLOOK, MOUSEFLOW, KLAVIYO, FULLSTORY, AMPLITUDE, SNOWPLOW, JUNE, MPARTICLE, BIGQUERY, RUDDERSTACK, SNOWFLAKE, GLASSBOX, HUBSPOT, AIR360, DATADOG, QUANTUM_METRIC, KAMELEOON_TRACKING, CUSTOM_TRACKING, VERCEL, AKAMAI]

type stringrequired

Type of the goal

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

Example (from schema)

{
  "accessLimiters": [
    {
      "accessHolder": "PERSONALIZATION",
      "accessHolderId": 0,
      "id": 0
    }
  ],
  "createdBy": 0,
  "dateCreated": "2024-07-29T15:51:28.071Z",
  "dateModified": "2024-07-29T15:51:28.071Z",
  "description": "string",
  "experimentAmount": 0,
  "experiments": [
    0
  ],
  "featureFlagAmount": 0,
  "hasMultipleConversions": true,
  "id": 0,
  "isTargetingSegmentMentalist": true,
  "mentalistWeight": 0,
  "name": "string",
  "params": {},
  "personalizationAmount": 0,
  "personalizations": [
    0
  ],
  "siteId": 0,
  "status": "ACTIVE",
  "tags": [
    "string"
  ],
  "trackingTools": [
    "GOOGLE_ANALYTICS4"
  ],
  "type": "CLICK"
}

400

Bad Request

*/*

Schema

Schema

code string
impersonator string
message string
name string
status string

Possible values: [SUCCESS, ERROR]

sub string
time int64
timestamp date-time

Example (from schema)

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-07-29T15:51:28.071Z"
}

401

Unauthorized

*/*

Schema

Schema

code string
impersonator string
message string
name string
status string

Possible values: [SUCCESS, ERROR]

sub string
time int64
timestamp date-time

Example (from schema)

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-07-29T15:51:28.071Z"
}

403

Forbidden

*/*

Schema

Schema

code string
impersonator string
message string
name string
status string

Possible values: [SUCCESS, ERROR]

sub string
time int64
timestamp date-time

Example (from schema)

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-07-29T15:51:28.071Z"
}

404

Not Found

*/*

Schema

Schema

code string
impersonator string
message string
name string
status string

Possible values: [SUCCESS, ERROR]

sub string
time int64
timestamp date-time

Example (from schema)

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-07-29T15:51:28.071Z"
}

423

Locked

*/*

Schema

Schema

code string
impersonator string
message string
name string
status string

Possible values: [SUCCESS, ERROR]

sub string
time int64
timestamp date-time

Example (from schema)

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-07-29T15:51:28.071Z"
}

500

Internal Server Error

*/*

Schema

Schema

code string
impersonator string
message string
name string
status string

Possible values: [SUCCESS, ERROR]

sub string
time int64
timestamp date-time

Example (from schema)

{
  "code": "string",
  "impersonator": "string",
  "message": "string",
  "name": "string",
  "status": "SUCCESS",
  "sub": "string",
  "time": 0,
  "timestamp": "2024-07-29T15:51:28.071Z"
}

Loading...