Conversion Goals

POST/{version}/api/get/setting-goals

Manage your conversion goals to track important customer actions.

Request

Path Params

versionstringrequired

v2-4-2

examplev2-4-2

Header Params

ApiKeystringrequired

default{{ApiKey}}

exampleYOUR_API_KEY

Body Params

application/json

Examples

JSON

{}

Responses

Body

application/json

codeintegerrequired

messagestringrequired

dataobjectrequired

Child fields

recordsarray [object]required

Child fields

namestringrequired

goal name

codestringrequired

goal code

event_typestringrequired

goal type

limit_typestringrequired

limlt type

limit_valuearray [string]required

limlt value

Child fields

string

data_sourceintegerrequired

conversion_numintegerrequired

Response Headers

Environmenthttps://data.api.attribuly.com

Open in Apifox

Request Example

cURL

curl --request POST \
+  --url 'https://data.api.attribuly.com/v2-4-2/api/get/setting-goals' \
+  --header 'ApiKey: YOUR_API_KEY' \
+  --header 'Content-Type: application/json' \
+  --data '{}'

Response Example

JSON

{
  "code": 1,
  "message": "Service succeed",
  "data": {
    "goals": [
      {
        "name": "Purchase",
        "code": "x4w0tc0elo0co1n9eftdalo100h8dp6k",
        "event_type": "checkout_completed",
        "limit_type": "no",
        "limit_value": [
          "1"
        ],
        "data_source": 1,
        "conversion_num": 0
      },
      {
        "name": "Add to cart",
        "code": "x4w0tc0szc0co1ngbm1iidg3001z2nn1",
        "event_type": "product_added_to_cart",
        "limit_type": "no",
        "limit_value": null,
        "data_source": 1,
        "conversion_num": 0
      }
    ]
  }
}