Skip to main content
GET
Get all goals

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

paramsIO
object
required
optionalFields
string[]

Response

OK

hasMultipleConversions
boolean
required

Indicates if this goal has multiple conversions

name
string
required

Name of the goal

siteId
integer<int64>
required

Site ID of the project that the goal belongs to

type
enum<string>
required

Type of goal

Available options:
CLICK,
CUSTOM,
SCROLL,
PAGE_VIEWS,
URL,
TIME_SPENT,
RETENTION_RATE,
WAREHOUSE,
RATIO_METRICS
accessLimiters
object[]
createdBy
integer<int64>
read-only

Account ID of the creator of the experiment

customDatas
object[]

List of custom data using this goal

dateCreated
string<date-time>
read-only
dateModified
string<date-time>
read-only
description
string
experimentAmount
integer<int64>
read-only

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

experiments
integer<int64>[]
read-only

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

featureFlagAmount
integer<int64>
read-only

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

holdoutAmount
integer<int64>
read-only

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

holdouts
integer<int64>[]
read-only

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

id
integer<int64>
read-only

Unique ID of the goal

isActive
boolean
deprecated
read-only

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

isTargetingSegmentMentalist
boolean
read-only

Indicates if the goal relates to a mentalist segment. This is an optional field that the request body includes

List of links to related entities. This is an optional field that the request body includes

mentalistWeight
number<double>
read-only
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.

personalizationAmount
integer<int64>
read-only

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

personalizations
integer<int64>[]
read-only

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

status
enum<string>

Indicates the status of the goal: active or inactive

Available options:
ACTIVE,
INACTIVE
tags
string[]

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

targetingSegmentMentalist
integer<int64>[]
trackingTools
enum<string>[]
Available options:
ADOBE_OMNITURE,
AIR360,
AKAMAI,
AMPLITUDE,
BIGQUERY,
BRAZE,
CLARITY,
COM_SCORE,
CONTENT_SQUARE,
CRAZY_EGG,
CUSTOM_INTEGRATIONS,
DATABRICKS,
DATADOG,
ECONDA,
EULERIAN,
FULLSTORY,
GLASSBOX,
GLASSBOX_V2,
GOOGLE_ANALYTICS4,
GOOGLE_ANALYTICS4_AUDIENCES,
GOOGLE_UNIVERSAL_ANALYTICS,
HEAP,
HEAP_COHORTS,
HUBSPOT,
IABTCF,
JUNE,
KISSMETRICS,
KLAVIYO,
KLAVIYO_COHORTS,
M_PATHY,
MIXPANEL,
MOUSEFLOW,
MPARTICLE,
PIANO,
PIWIK,
QUANTUM_METRIC,
REDSHIFT,
RUDDERSTACK,
SEGMENT,
SMART_TAG,
SMARTLOOK,
SNOWFLAKE,
SNOWPLOW,
TAG_COMMANDER,
TEALIUM,
VERCEL,
WEBTREKK,
WEBTRENDS,
KAMELEOON_TRACKING,
CUSTOM_TRACKING