Method for goal achievement

In some cases, it is necessary to manually provide information that a client has achieved a certain goal. For example, if the goal achievement occurs not on the website (in a mobile application or even in your CRM).

This functionality is analogous to offline conversions in Yandex.Metrika (opens new window)

Method description

POST: https://api.sustain-impact.de/outer/v1.0/goal/reach

Request body:
{
    "Ip": "<Client's (user's) IP. Optional>",
	"GoalId": "<Goal Id in FunnelFlex.AI. Required>",
	"CustomerId": "<Client Id in FunnelFlex.AI. Required>",
	"CreatedOnUtc": "<Time of conversion in UTC. Optional>",
	"CustomUserScopeParams": "<User parameters. Optional>",
	"CustomPageScopeParams": "<Page parameters. Optional>"
}

Request body examples

{
    "Ip": "185.237.80.128",
    "GoalId": "299837db-9b51-45a4-996b-844d3fd05bbd",
    "CustomerId": "2eccd743-4164-4892-a416-dc5c16f44971",
    "CreatedOnUtc": "2022-10-27 12:23:25.367999",
    "CustomUserScopeParams": {
        "Revenue": "12350",
        "NetProfit": "900"
    },
    "CustomPageScopeParams": {
    }
}

Или

{
    "GoalId": "299837db-9b51-45a4-996b-844d3fd05bbd",
    "CustomerId": "2eccd743-4164-4892-a416-dc5c16f44971",
    "CustomPageScopeParams": {
        "Revenue": "12350",
        "NetProfit": "900"
    }
}

Ip

The IP address of the user who made the conversion - optional but recommended to enrich data on the FunnelFlex.AI side.

GoalId

GoalId is a unique ID of the goal in the FunnelFlex.AI system. Note - in the FunnelFlex.AI system, not in the system from which the data is transmitted.

GoalId can be obtained, for example, in the address bar of the goal editor:

https://app.sustain-impact.de/goal/<Id будет ут>/edition

It is a GUID/UUID GUID/UUID (opens new window) - for example, ea565c1b-70b1-4165-bd39-4df0d4e4f9bc.

CustomerId

CustomerId can be obtained by calling the JS method within your website:

//Deprecated version
window.SustainImpact.getCustomerId() // This is a synchronous function, it will only work when window.SustainImpact.ready == true

//New version (asynchronous) - option 1
impact('getCustomerIdAsync').then(id => {
    //id parameter will return the customer id
})

//ew version (asynchronous) - option 2
const id = await impact('getCustomerIdAsync')

If successful, the method will return an empty response with status 200 OK (opens new window).

Information about the achieved goal (conversion) will appear in the system after some time.

CustomUserScopeParams

In the CustomUserScopeParams parameter, you can pass custom client parameters as a key-value object.

Custom client parameters are used to enrich data. This can include passing revenue or net profit. Each parameter value must be a string (not 12500, but "12500").

CustomPageScopeParams

In the CustomPageScopeParams parameter, you can pass custom page parameters as a key-value object.

Custom page parameters are used to enrich data. This can include passing revenue or net profit. Each parameter value must be a string (not 12500, but "12500").