Create a Goal - Leadfeeder API

Create a goal in the account. A goal only marks page views tracked after it is created; earlier visits are not re-checked. The goal's custom feed is created in the background, so relationships.custom_feed is usually null in the response.

The operators each criterion.field accepts:

`field`	Operators
`page_url`	`is`, `is_not`, `begins_with`, `not_begins_with`, `ends_with`, `contains`, `not_contains`
`page`	`is`, `is_not`, `begins_with`, `ends_with`, `contains`, `not_contains`
`form_submit`	`is`, `is_not`, `is_present`, `is_empty`
`file_download_name`	`is`, `is_not`, `contains`, `is_present`, `is_empty`
`video_title`	`is`, `is_not`, `begins_with`, `contains`, `is_present`, `is_empty`
`video_url`	`is`, `is_not`, `begins_with`, `is_present`, `is_empty`

Credit Note: Creating a goal does not consume credits.

INFO

Requires the web_visits:write OAuth2 scope.

Request

Authorization

API Key

Add parameter in header

X-Api-Key

Example:

X-Api-Key: ********************

Query Params

Body Params application/jsonRequired

Examples

Any form submissionPage URL

A goal met by every form submission, created disabled

{
    "data": {
        "attributes": {
            "criterion": {
                "field": "form_submit",
                "operator": "is_present"
            },
            "enabled": false,
            "name": "Any form"
        },
        "type": "goal"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

Success

Bodyapplication/json

Example

{
    "data": {
        "attributes": {
            "created_at": "2026-10-01T10:00:00.000Z",
            "criterion": {
                "field": "page_url",
                "operator": "contains",
                "value": "/pricing"
            },
            "enabled": true,
            "name": "Pricing page",
            "updated_at": "2026-10-02T11:00:00.000Z"
        },
        "id": "4182",
        "relationships": {
            "custom_feed": {
                "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
                "type": "custom_feed"
            }
        },
        "type": "goal"
    },
    "meta": {
        "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠422Parameter Error

🟠429

🔴500Server Error

🔴504Gateway Timeout