Conversion Funnel

To view already existing conversion funnels assigned to a certain Buyer, GET the following endpoint:

/api/dsp/<dsp_id>/conversion-funnel/

The <dsp_id> is the unique identifier of a Buyer, for example 123.

You can also GET specific conversion funnels with the following endpoint:

/api/conversion-funnel/<id>/

The <id> is the unique identifier of a conversion funnel, for example 5.

Creating A Conversion Funnel

To create a conversion funnel, POST the details to the following endpoint:

/api/conversion-funnel/

{
  "name": "funnel1",
  "origins": [
    "example.com",
    "yourdomain.com"
  ],
  "dsp_id": 123
}

If the request is handled successfully, the system returns the 201 response code, otherwise the 400 response code is returned together with the response body.

Updating A Conversion Funnel

To update an existing conversion funnel, PATCH the details to the following endpoint:

/api/conversion-funnel/<id>/

The PATCH request contains only updated fields.

The <id> is the unique identifier of a conversion funnel, for example 5. Make sure you use the correct identifier before sending your query.

{
  "name": "funnel1",
  "origins": [
    "example.com",
    "yourdomain.com"
  ],
  "dsp_id": 123
}

If the request is handled successfully, the system returns the 200 response code, otherwise the 400 response code is returned together with the response body.

Deleting A Conversion Funnel

Warning

Conversion funnels with assigned conversions cannot be deleted

To delete a conversion funnel, use the DELETE method with the following endpoint:

/api/conversion-funnel/<id>/

The <id> is the unique identifier of a conversion funnel, for example 5. Make sure you use the correct identifier before sending your query.

If the request is handled successfully, the system responds with 204.

API Fields

Conversion funnels are represented with the following API fields.

Field	Type	Description
name	string	The unique name of the conversion funnel
id	integer	(Read-only) The unique numeric ID of the conversion funnel. Generated when the conversion funnel is created
origins	array of strings	A set of domains from which conversion are generated
conversions	array of integers	(Response only) The unique IDs of conversions assigned to the conversion funnel
dsp_id	integer	The unique ID of the Buyer to which the funnel is assigned