Search goals
POST/goals/search
Search for goals
Requestβ
Query Parameters
- application/json
Body
required
- FilteringCondition
- FilteringLogic
Array [
- FilteringCondition
]
Array [
]
filter
object
oneOf
Possible values: [EQUAL
, NOT_EQUAL
, LESS
, GREATER
, LESS_OR_EQUAL
, GREATER_OR_EQUAL
, LIKE
, NOT_LIKE
, BETWEEN
, IN
, NOT_IN
, NOT
, IS_NULL
, IS_NOT_NULL
, IS_TRUE
, IS_FALSE
, IS_EMPTY
, IS_NOT_EMPTY
, CONTAINS
]
Possible values: [AND
, OR
]
expressions
object[]
oneOf
Filtering expression
Possible values: [EQUAL
, NOT_EQUAL
, LESS
, GREATER
, LESS_OR_EQUAL
, GREATER_OR_EQUAL
, LIKE
, NOT_LIKE
, BETWEEN
, IN
, NOT_IN
, NOT
, IS_NULL
, IS_NOT_NULL
, IS_TRUE
, IS_FALSE
, IS_EMPTY
, IS_NOT_EMPTY
, CONTAINS
]
Page number
Number of items per page
sort
object[]
Sorting parameters
Sorting direction
Possible values: [ASC
, DESC
]
Sorting field name
Responsesβ
- 200
- 400
- 401
- 403
- 404
- 423
- 500
OK
- */*
- Schema
- Example (from schema)
Schema
Array [
Array [
]
Array [
]
- AccessToPageGoalParams
- ClickTrackingGoalParams
- PageViewsGoalParams
- ScrollTrackingGoalParams
- TimeSpentGoalParams
Array [
]
]
accessLimiters
object[]
Possible values: [PERSONALIZATION
, AB_TEST
, TAG
]
Account Id of the creator of the experiment
customDatas
object[]
List of custom data using this goal
Variable name of the Adobe Analytics
Enables the selection of custom data values for targeting conditions by displaying them in a select box rather than a simple text field.
Account Id of the creator of the custom data
Custom code that will be executed
Date and time a record is created
Description of the custom data
Custom data value format
Possible values: [BOOLEAN
, NUMBER
, STRING
]
Variable name of the Google Tag Manager
Unique Id of the custom data.
Indicates whether the custom data is a constant
Indicates whether custom data should be filtered and marked as available for breakdown
Indicates whether this data should be included in Kameleoon machine learning
Indicates whether the data is only stored on the user's device.
Method through which a custom data will be transmitted
Possible values: [ADOBE_ANALYTICS
, CLIENT
, CUSTOM_CODE
, GTM
, SDK
, TC
, TEALIUM
]
Date and time a record is modified
Name of the given custom data
System generated code to uniquely identify a website.
This is an optional field needs to specify in request params.
Unique project identifier assigned to the record
Field to store tags that are associated with this record
Name for the tag commander data layer, if it is selected as a transmission method
Name for the Tealium, if it is selected as a transmission method
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
]
Number of experiments using this goal. This is an optional field that has to be specified in request params.
List of experiment ids using this goal. This is an optional field that has to be specified in request params.
Number of feature flags using this goal. This is an optional field that has to be specified in request params.
Indicates if this goal has multiple conversions
Number of holdouts using this goal. This is an optional field needs to specify in request params.
List of holdout ids using this goal. This is an optional field needs to specify in request params.
Unique Id of the goal
Deprecated. Use status instead. Indicates the status of the goal: active or not
Indicates that the goal related to a mentalist segment. This is an optional field that has to be specified in request params.
Name of the goal
params
object
oneOf
Possible values: [CONTAINS
, CORRESPONDS_EXACTLY
, REGULAR_EXPRESSION
]
customSelectors
object[]
Selection with a CSS selector. CSS selector to track the corresponding element
Possible values: [ID
, CLASS
, TAG
, TAG_CLASS
, CUSTOM
, AUTOGENERATED
, CONTENT
, CUSTOM_ATTRIBUTE
]
URL of the page on which you want to create your click tracker. Example: www.mozilla.org
Possible values: [MORE_THAN
, EQUALS
, LESS_THAN
]
When the user scrolls down to
Possible values: [ELEMENT
, PERCENTAGE
, PIXELS_HEIGHT
]
Scroll tracking value
Possible values: [MORE_THAN
, EQUALS
, LESS_THAN
]
Number of personalizations using this goal. This is an optional field that has to be specified in request params.
List of personalization ids using this goal. This is an optional field that has to be specified in request params.
Site Id of the project that the goal belongs to
Indicates the status of the goal: active or inactive
Possible values: [ACTIVE
, INACTIVE
]
List of tags using by this goal. For GET requests: this is an optional field that has to be specified in request params.
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
, KAMELEOON_TRACKING
, CUSTOM_TRACKING
, VERCEL
, AKAMAI
]
Type of the goal
Possible values: [CLICK
, CUSTOM
, SCROLL
, PAGE_VIEWS
, URL
, TIME_SPENT
, RETENTION_RATE
, WAREHOUSE
, RATIO_METRICS
]
[
{
"accessLimiters": [
{
"accessHolder": "PERSONALIZATION",
"accessHolderId": 0,
"id": 0
}
],
"createdBy": 0,
"customDatas": [
{
"adobeAnalyticsVariableName": "string",
"advancedProposedValues": "string",
"createdById": 0,
"customEvalCode": "string",
"dateCreated": "2024-07-29T15:51:28.071Z",
"description": "string",
"format": "BOOLEAN",
"gtmVariableName": "string",
"id": 0,
"index": 0,
"isConstant": true,
"isFiltrableVentilable": true,
"isLearnable": true,
"isLocalOnly": true,
"method": "ADOBE_ANALYTICS",
"modificationDate": "2024-07-29T15:51:28.071Z",
"name": "string",
"siteCode": "string",
"siteId": 0,
"tags": "string",
"tcVariableName": "string",
"tealiumVariableName": "string",
"type": "COUNT_LIST"
}
],
"dateCreated": "2024-07-29T15:51:28.071Z",
"dateModified": "2024-07-29T15:51:28.071Z",
"description": "string",
"experimentAmount": 0,
"experiments": [
0
],
"featureFlagAmount": 0,
"hasMultipleConversions": true,
"holdoutAmount": 0,
"holdouts": [
0
],
"id": 0,
"isTargetingSegmentMentalist": true,
"mentalistWeight": 0,
"name": "string",
"params": {},
"personalizationAmount": 0,
"personalizations": [
0
],
"siteId": 0,
"status": "ACTIVE",
"tags": [
"string"
],
"trackingTools": [
"GOOGLE_ANALYTICS4"
],
"type": "CLICK"
}
]
Bad Request
- */*
- Schema
- Example (from schema)
Schema
Possible values: [SUCCESS
, ERROR
]
{
"code": "string",
"impersonator": "string",
"message": "string",
"name": "string",
"status": "SUCCESS",
"sub": "string",
"time": 0,
"timestamp": "2024-07-29T15:51:28.071Z"
}
Unauthorized
- */*
- Schema
- Example (from schema)
Schema
Possible values: [SUCCESS
, ERROR
]
{
"code": "string",
"impersonator": "string",
"message": "string",
"name": "string",
"status": "SUCCESS",
"sub": "string",
"time": 0,
"timestamp": "2024-07-29T15:51:28.071Z"
}
Forbidden
- */*
- Schema
- Example (from schema)
Schema
Possible values: [SUCCESS
, ERROR
]
{
"code": "string",
"impersonator": "string",
"message": "string",
"name": "string",
"status": "SUCCESS",
"sub": "string",
"time": 0,
"timestamp": "2024-07-29T15:51:28.071Z"
}
Not Found
- */*
- Schema
- Example (from schema)
Schema
Possible values: [SUCCESS
, ERROR
]
{
"code": "string",
"impersonator": "string",
"message": "string",
"name": "string",
"status": "SUCCESS",
"sub": "string",
"time": 0,
"timestamp": "2024-07-29T15:51:28.071Z"
}
Locked
- */*
- Schema
- Example (from schema)
Schema
Possible values: [SUCCESS
, ERROR
]
{
"code": "string",
"impersonator": "string",
"message": "string",
"name": "string",
"status": "SUCCESS",
"sub": "string",
"time": 0,
"timestamp": "2024-07-29T15:51:28.071Z"
}
Internal Server Error
- */*
- Schema
- Example (from schema)
Schema
Possible values: [SUCCESS
, ERROR
]
{
"code": "string",
"impersonator": "string",
"message": "string",
"name": "string",
"status": "SUCCESS",
"sub": "string",
"time": 0,
"timestamp": "2024-07-29T15:51:28.071Z"
}