Skip to main content

Search goals

POST 
/goals/search

Search for goals

Request​

Query Parameters

    optionalFields string[]

Body

required

    filter

    object

    oneOf

    field string
    operator string

    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]

    parameters object[]
    page int32

    Page number

    perPage int32

    Number of items per page

    sort

    object[]

    Sorting parameters

  • Array [

    • direction string

    Sorting direction

    Possible values: [ASC, DESC]

    field string

    Sorting field name

  • ]

Responses​

OK

Schema

  • Array [

    • 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

    matchString string
    matchType string

    Possible values: [CONTAINS, CORRESPONDS_EXACTLY, REGULAR_EXPRESSION]

    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]

  • ]

Loading...