Objectifs

GET https://dash.pulselyx.com/api/goals/
curl --request GET \
--url 'https://dash.pulselyx.com/api/goals/' \
--header 'Authorization: Bearer {api_key}' \
Paramètres Détails Description
website_id Facultatif Entier
type Facultatif Chaîne Valeurs autorisées : pageview, custom, scroll, scroll_element, click_element, webhook
search Facultatif Chaîne La chaîne de recherche.
search_by Facultatif Chaîne Par quel champ recherchez-vous. Les valeurs autorisées sont : name, path, key.
datetime_field Facultatif Chaîne Valeurs autorisées : datetime, last_datetime
datetime_start Facultatif Chaîne Filter results starting from this datetime. Y-m-d H:i:s format.
datetime_end Facultatif Chaîne Filter results up to this datetime. Y-m-d H:i:s format.
order_by Facultatif Chaîne Par quel champ trier les résultats. Les valeurs autorisées sont : goal_id, last_datetime, datetime, name, path, key, scroll_percentage.
order_type Facultatif Chaîne L'ordre des résultats. Les valeurs autorisées sont : ASC pour l'ordre croissant et DESC pour l'ordre décroissant.
page Facultatif Entier Le numéro de la page dont vous souhaitez obtenir les résultats. La valeur par défaut est 1.
results_per_page Facultatif Entier Combien de résultats souhaitez-vous par page. Les valeurs autorisées sont : 10, 25, 50, 100, 250, 500, 1000. La valeur par défaut est 25.
{
    "data": [
        {
            "id": 1,
            "website_id": 1,
            "user_id": 1,
            "key": "123456789",
            "type": "custom",
            "path": null,
            "scroll_percentage": null,
            "scroll_selector": null,
            "click_selector": null,
            "value": null,
            "webhook_url": null,
            "name": "Example",
            "last_datetime": null,
            "datetime": "2026-11-18 21:01:28"
        }
    ],
    "meta": {
        "page": 1,
        "total_pages": 1,
        "results_per_page": 25,
        "total_results": 1
    },
    "links": {
        "first": "https://dash.pulselyx.com/api/goals?page=1",
        "last": "https://dash.pulselyx.com/api/goals?page=1",
        "next": null,
        "prev": null,
        "self": "https://dash.pulselyx.com/api/goals?page=1"
    }
}
GET https://dash.pulselyx.com/api/goals/{goal_id}
curl --request GET \
--url 'https://dash.pulselyx.com/api/goals/{goal_id}' \
--header 'Authorization: Bearer {api_key}' \
{
    "data": {
        "id": 1,
        "website_id": 1,
        "user_id": 1,
        "key": "123456789",
        "type": "custom",
        "path": null,
        "scroll_percentage": null,
        "scroll_selector": null,
        "click_selector": null,
        "value": null,
        "webhook_url": null,
        "name": "Example",
        "last_datetime": null,
        "datetime": "2026-11-18 21:01:28"
    }
}
POST https://dash.pulselyx.com/api/goals
Paramètres Détails Description
website_id Requis Entier -
type Requis Chaîne Valeurs autorisées : pageview, custom, scroll, scroll_element, click_element, webhook
name Requis Chaîne -
path Facultatif Chaîne Disponible lorsque : type = pageview, scroll, scroll_element, click_element
scroll_percentage Facultatif Entier Disponible lorsque : type = scroll
scroll_selector Requis Chaîne Disponible lorsque : type = scroll_element. The goal converts when the first matching element enters the viewport, including when already in view on page load. Enter a valid CSS selector with up to 1024 characters.
click_selector Requis Chaîne Disponible lorsque : type = click_element. The goal converts when a visitor clicks any matching element, including an icon or text inside it. Enter a valid CSS selector with up to 1024 characters.
value Facultatif Flottant Optional amount saved with each new conversion. Leave empty to track conversions without a value. Use the same unit or currency across this website. Enter a nonnegative value below 10000000000000 with up to 2 decimal places.
key Facultatif Chaîne -
curl --request POST \
--url 'https://dash.pulselyx.com/api/goals' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'website_id=1' \
--form 'name=Example' \
--form 'type=click_element' \
--form 'path=blog/*' \
--form 'click_selector=.buy-button' \
{
    "data": {
        "id": 1,
        "website_id": 1,
        "user_id": 1,
        "key": "123456789",
        "type": "click_element",
        "path": "/blog/*",
        "scroll_percentage": null,
        "scroll_selector": null,
        "click_selector": ".buy-button",
        "value": null,
        "webhook_url": null,
        "name": "Example",
        "last_datetime": null,
        "datetime": "2026-11-18 21:01:28"
    }
}
POST https://dash.pulselyx.com/api/goals/{goal_id}
Paramètres Détails Description
website_id Facultatif Entier -
type Facultatif Chaîne Valeurs autorisées : pageview, custom, scroll, scroll_element, click_element, webhook
name Facultatif Chaîne -
path Facultatif Chaîne Disponible lorsque : type = pageview, scroll, scroll_element, click_element
scroll_percentage Facultatif Entier Disponible lorsque : type = scroll
scroll_selector Facultatif Chaîne Disponible lorsque : type = scroll_element. The goal converts when the first matching element enters the viewport, including when already in view on page load. Enter a valid CSS selector with up to 1024 characters.
click_selector Facultatif Chaîne Disponible lorsque : type = click_element. The goal converts when a visitor clicks any matching element, including an icon or text inside it. Enter a valid CSS selector with up to 1024 characters.
value Facultatif Flottant Optional amount saved with each new conversion. Leave empty to track conversions without a value. Use the same unit or currency across this website. Enter a nonnegative value below 10000000000000 with up to 2 decimal places.
key Facultatif Chaîne -
curl --request POST \
--url 'https://dash.pulselyx.com/api/goals/{goal_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'type=scroll' \
--form 'path=blog/*' \
--form 'scroll_percentage=75' \
{
    "data": {
        "id": 1,
        "website_id": 1,
        "user_id": 1,
        "key": "123456789",
        "type": "scroll",
        "path": "/blog/*",
        "scroll_percentage": 75,
        "scroll_selector": null,
        "click_selector": null,
        "value": null,
        "webhook_url": null,
        "name": "Example",
        "last_datetime": "2026-11-18 21:01:28",
        "datetime": "2026-11-18 21:01:28"
    }
}

Send a POST request to the private webhook URL shown when editing your goal. JSON and form data are supported. An empty POST also records a conversion.

Webhook goals return a private webhook_url in the response. Use this URL to submit conversions without an API key.

Submit a value to record an actual amount, or omit it to use the configured conversion value. Only the conversion time and value are stored. Each accepted POST counts separately, including repeated requests. Webhook conversions are not linked to visitors, sessions, or page events.

POST https://dash.pulselyx.com/pixel-webhook/{webhook_key}
curl --request POST \
--url 'https://dash.pulselyx.com/pixel-webhook/{webhook_key}' \
--header 'Content-Type: application/json' \
--data '{"value":49.90}'
{"message":"","status":"success","details":[]}
DELETE https://dash.pulselyx.com/api/goals/{goal_id}
curl --request DELETE \
--url 'https://dash.pulselyx.com/api/goals/{goal_id}' \
--header 'Authorization: Bearer {api_key}' \