curl --request GET \
--url https://api.kameleoon.com/goals/{goalId} \
--header 'Authorization: Bearer <token>'{
"hasMultipleConversions": true,
"name": "<string>",
"siteId": 123,
"type": "CLICK",
"accessLimiters": [
{
"accessHolder": "PERSONALIZATION",
"accessHolderId": 123,
"id": 123
}
],
"createdBy": 123,
"customDatas": [
{
"method": "ADOBE_ANALYTICS",
"name": "<string>",
"siteId": 123,
"adobeAnalyticsVariableName": "<string>",
"advancedProposedValues": "<string>",
"createdById": 123,
"customEvalCode": "<string>",
"dateCreated": "2023-11-07T05:31:56Z",
"description": "<string>",
"format": "BOOLEAN",
"gtmVariableName": "<string>",
"id": 123,
"index": 123,
"isConstant": true,
"isFiltrableVentilable": true,
"isLearnable": true,
"isLocalOnly": true,
"modificationDate": "2023-11-07T05:31:56Z",
"siteCode": "<string>",
"tags": "<string>",
"tcVariableName": "<string>",
"tealiumVariableName": "<string>",
"type": "COUNT_LIST"
}
],
"dateCreated": "2023-11-07T05:31:56Z",
"dateModified": "2023-11-07T05:31:56Z",
"description": "<string>",
"experimentAmount": 123,
"experiments": [
123
],
"featureFlagAmount": 123,
"holdoutAmount": 123,
"holdouts": [
123
],
"id": 123,
"isActive": true,
"isTargetingSegmentMentalist": true,
"mentalistWeight": 123,
"params": {
"matchString": "<string>",
"matchType": "CONTAINS"
},
"personalizationAmount": 123,
"personalizations": [
123
],
"status": "ACTIVE",
"tags": [
"<string>"
],
"targetingSegmentMentalist": [
123
],
"trackingTools": [
"GOOGLE_ANALYTICS4"
]
}Retrieves the goal with the specified ID. Refer to this guide to use optional fields.
curl --request GET \
--url https://api.kameleoon.com/goals/{goalId} \
--header 'Authorization: Bearer <token>'{
"hasMultipleConversions": true,
"name": "<string>",
"siteId": 123,
"type": "CLICK",
"accessLimiters": [
{
"accessHolder": "PERSONALIZATION",
"accessHolderId": 123,
"id": 123
}
],
"createdBy": 123,
"customDatas": [
{
"method": "ADOBE_ANALYTICS",
"name": "<string>",
"siteId": 123,
"adobeAnalyticsVariableName": "<string>",
"advancedProposedValues": "<string>",
"createdById": 123,
"customEvalCode": "<string>",
"dateCreated": "2023-11-07T05:31:56Z",
"description": "<string>",
"format": "BOOLEAN",
"gtmVariableName": "<string>",
"id": 123,
"index": 123,
"isConstant": true,
"isFiltrableVentilable": true,
"isLearnable": true,
"isLocalOnly": true,
"modificationDate": "2023-11-07T05:31:56Z",
"siteCode": "<string>",
"tags": "<string>",
"tcVariableName": "<string>",
"tealiumVariableName": "<string>",
"type": "COUNT_LIST"
}
],
"dateCreated": "2023-11-07T05:31:56Z",
"dateModified": "2023-11-07T05:31:56Z",
"description": "<string>",
"experimentAmount": 123,
"experiments": [
123
],
"featureFlagAmount": 123,
"holdoutAmount": 123,
"holdouts": [
123
],
"id": 123,
"isActive": true,
"isTargetingSegmentMentalist": true,
"mentalistWeight": 123,
"params": {
"matchString": "<string>",
"matchType": "CONTAINS"
},
"personalizationAmount": 123,
"personalizations": [
123
],
"status": "ACTIVE",
"tags": [
"<string>"
],
"targetingSegmentMentalist": [
123
],
"trackingTools": [
"GOOGLE_ANALYTICS4"
]
}Documentation Index
Fetch the complete documentation index at: https://docs.kameleoon.com/llms.txt
Use this file to discover all available pages before exploring further.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
OK
Indicates if this goal has multiple conversions
Name of the goal
Site Id of the project that the goal belongs to
Type of goal
CLICK, CUSTOM, SCROLL, PAGE_VIEWS, URL, TIME_SPENT, RETENTION_RATE, WAREHOUSE, RATIO_METRICS Show child attributes
Account Id of the creator of the experiment
List of custom data using this goal
Show child attributes
Number of experiments using this goal. This is an optional field that that is included in the request body
List of experiment ids using this goal. This is an optional field that is included in the request body
List of experiment ids using this goal. This is an optional field that is included in the request body
Number of feature flags using this goal. This is an optional field that that is included in the request body
Number of holdouts using this goal. This is an optional field that is included in the request body
List of holdout ids using this goal. This is an optional field that is included in the request body
List of holdout ids using this goal. This is an optional field that is included in the request body
Unique Id of the goal
Deprecated. Use status instead. Indicates the status of the goal: active or not
Indicates if the goal is related to a mentalist segment. This is an optional field that is included in the request body
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.
Show child attributes
Number of personalizations using this goal. This is an optional field that is included in the request body
List of personalization ids using this goal. This is an optional field that is included in the request body
List of personalization ids using this goal. This is an optional field that is included in the request body
Indicates the status of the goal: active or inactive
ACTIVE, INACTIVE List of tags belonging to this goal. For GET requests: this is an optional field that has to be specified in request params.
List of tags belonging to this goal. For GET requests: this is an optional field that has to be specified in request params.
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, HEAP_COHORTS, 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, BRAZE, KAMELEOON_TRACKING, CUSTOM_TRACKING, VERCEL, AKAMAI Was this page helpful?