API ReferenceAnnouncementsCommunity Discussion
API ReferenceCommunity DiscussionAnnouncementsSubscribeLog In
API Reference

Get All Conversion Rules

Returns all conversion rules available to that account - including conversion rules created at the network level.

Sample request:

GET /backstage/api/1.0/demo-advertiser-1/universal_pixel/conversion_rule
{
    "results": [
        //...
        {
            "id": 60,
            "display_name": "Lead",
            "look_back_window": null,
            "category": "LEAD",
            "status": "ACTIVE",
            "type": "EVENT_BASED",
            "event_name": "lead",
            "condition": {
                "property": null,
                "predicate": null,
                "value": null,
                "children": null
            },
            "effects": [],
            "include_in_total_conversions": true,
            "exclude_from_campaigns": false,
            "description": null,
            "advertiser_id": "demo-advertiser-1",
            "last_modified_by": "[email protected]",
            "last_modified_at": "2020-04-11"
        },
        {
            "id": 61,
            "display_name": "Product View",
            "look_back_window": null,
            "category": "VIEW_CONTENT",
            "status": "ACTIVE",
            "type": "BASIC",
            "event_name": "page_view",
            "condition": {
                "property": "URL",
                "predicate": "CONTAINS",
                "value": "/products/",
                "children": []
            },
            "effects": [],
            "include_in_total_conversions": false,
            "exclude_from_campaigns": false,
            "description": null,
            "advertiser_id": "demo-advertiser-1",
            "last_modified_by": "[email protected]",
            "last_modified_at": "2020-05-31"
        },
        {
            "id": 86,
            "display_name": "Thank you",
            "look_back_window": 30,
            "category": "ADD_TO_WISHLIST",
            "status": "DISABLED",
            "type": "BASIC",
            "event_name": "page_view",
            "condition": {
                "property": "URL",
                "predicate": "CONTAINS",
                "value": "demo-advertiser.com/thankyou",
                "children": []
            },
            "effects": [],
            "include_in_total_conversions": true,
            "exclude_from_campaigns": false,
            "description": null,
            "advertiser_id": "demo-advertiser-network",
            "last_modified_by": "[email protected]",
            "last_modified_at": "2020-07-15"
        }
    ],
    "metadata": {
        //...
    }
}

📘

Returns all conversion rules available to that account - including conversion rules created at the network level.

📘

The response body is a valid JSON object, with a results property that contains the list of Conversion Rules.

Language