v1

latestOpenAPI 3.1.02026-07-26950137.9 KB

Create a Conversion Rule

Submit a JSON object representing the new Conversion Rule in the request body. (See examples below.)

Returns the newly created Conversion Rule in the response body.

post/backstage/api/1.0/{account_id}/universal_pixel/conversion_rule/

Path parameters

account_idstring required

An alphabetic ID. See Get Account Details.

Request body

RAW_BODYstring json required

A JSON object representing the new Conversion Rule.<br>(See below for an example.)

Response

200

idinteger

display_namestring

{"stackTrail":"paths:/backstage/api/1.0/{account_id}/universal_pixel/conversion_rule/:post:responses:200:content:application/json:schema:properties:look_back_window","oasType":"schema","type":"unknown"}

categorystring

statusstring

typestring

event_namestring

include_in_total_conversionsboolean

exclude_from_campaignsboolean

{"stackTrail":"paths:/backstage/api/1.0/{account_id}/universal_pixel/conversion_rule/:post:responses:200:content:application/json:schema:properties:description","oasType":"schema","type":"unknown"}

advertiser_idstring

last_modified_bystring

{"stackTrail":"paths:/backstage/api/1.0/{account_id}/universal_pixel/conversion_rule/:post:responses:200:content:application/json:schema:properties:last_modified_at","oasType":"schema","type":"unknown"}

Example response

{
  "id": 78,
  "display_name": "Add to cart",
  "category": "ADD_TO_CART",
  "status": "ACTIVE",
  "type": "BASIC",
  "event_name": "page_view",
  "condition": {
    "property": "URL",
    "predicate": "CONTAINS",
    "value": "test.com"
  },
  "effects": [
    {
      "type": "REVENUE",
      "data": "15"
    }
  ],
  "include_in_total_conversions": true,
  "advertiser_id": "rsschecking",
  "last_modified_by": "peter.taboola@gmail.com"
}