Data Pipelines¶

LiteSwitch has two data pipelines, one for impression data and the other for yes-bid data, that are essential for accurately predicting the value of future traffic and enabling more advanced features. It is important that both data pipelines are set up as well as possible to ensure stable data processing. If there are any questions or concerns about the setup of either, please reach out to your Account Manager for assistance.

Impression Data¶

Impression Events¶

For LiteSwitch to accurately predict the value of future traffic, the current impression and price data needs to be fed back to a LiteSwitch endpoint, where it can be merged with the data from the initial recommendation request. To do this, you should send this information to the endpoint described below.

Impression events should be sent to the LiteSwitch deployment - the same cluster that receives bid traffic.

Handler Description¶

Handler Syntax

/v2/<platform_name>_imp?features[]=${FEATURES_NAMES}&bid_id=${BIDID}&imp_id=${IMPID}&dsp_id=${SEATID}&price=${AUCTION_PRICE}

where:

<platform_name> - LiteSwitch client identifier - the same one used in the bid endpoint path. Lowercase letters, digits and underscores only.

Query Parameters

Parameter	Values	Notes
`features[]`	sidecar, ingress, opd	Required. Indicates which LiteSwitch features applied. The square brackets are part of the parameter name. Values that match the integration should be used. When a single impression genuinely belongs to more than one pipeline, multiple values can be sent.
`bid_id`	string	Required. The `id` field’s value of the original bid request. For sidecar setup: must be identical to the `bid_id` of the corresponding yes-bid event.
`imp_id`	string	Required. The `imp.id` field’s value of the original bid request.
`dsp_id`	string	Required. The winning Buyer, identified by their downstream seat ID. Note For ingress setup - LiteSwitch does not use the value from the parameter. If the winning Buyer’s seat ID isn’t readily available on the platform side, we recommend to send any fixed placeholder value on all impression requests - for example `dsp_id=<platform_name>`
`price`	integer	Required. The auction winning price in CPM.

Example¶

curl -X GET "<onprem-liteswitch-endpoint>/v2/<platform_name>_imp?features[]=sidecar&bid_id=abc123&price=1.12&dsp_id=lop098&imp_id=2"

where:

<onprem-liteswitch-endpoint> - the base URL of the client’s LiteSwitch deployment. This is the same cluster that serves bid traffic.

Yes-bid Data¶

Win Notification (Yes-bid) Events¶

Returning Yes-bid data to LiteSwitch helps to optimise its functionality and is required to enable some of its more advanced features. To return the Yes-bid data requires the same parameters as mentioned above in the impression data, plus the following additional parameter.

Applicable for the sidecar LiteSwitch deployment.

Win notification events (yes-bid of an internal auction winner) should be sent to the LiteSwitch sidecar deployment - the same cluster that receives bid traffic.

Handler description¶

Handler Syntax

/<platform_name>_yesbid?bid_id=${BIDID}&imp_id=${IMPID}&dsp_id=${SEATID}&bc=${BID_CONTEXT}&price=${AUCTION_PRICE}

where:

<platform_name> - LiteSwitch client identifier - the same one used in the bid endpoint path. Lowercase letters, digits and underscores only.

Query Parameters

Parameter	Values	Notes
`bid_id`	string	Required. The `id` field’s value of the original bid request.
`imp_id`	string	Required. The `imp.id` field’s value of the original bid request. Must be valid against the bid-context.
`dsp_id`	string	Required. The winning Buyer, identified by their downstream seat ID. For ingress setup, LiteSwitch does not use the value from the parameter. If the winning Buyer’s seat ID isn’t readily available on platform side, we recommend to send any fixed placeholder value on all impression requests - for example `dsp_id=<platform_name>`
`bc`	string	Required. An encoded bid-context parameter that LiteSwitch returns in the Recommendations Response. Echo the value back unchanged.
`price`	integer	Required. The auction winning price, expressed in CPM.

Example¶

curl -X GET "<onprem-liteswitch-endpoint>/<platform_name>_yesbid?bid_id=abc123&imp_id=2&dsp_id=lop098&bc=eyJpbXAiOlt7ImlkIjoiMSIsInJlY3MiOlt7InNlYXQiOiI2OCIsInJlYyI6MH0seyJzZWF0IjoiOTkiLCJyZWMiOjF9LHsic2VhdCI6IjE0NSIsInJlYyI6MH1dfV0sImxlYXJuaW5nIjowLCJiYyI6IlltRnpaVFkwSUdsdWMybGtaU0JpWVhObE5qUT0ifQ==&price=1.12"

where:

<onprem-liteswitch-endpoint> - the base URL of the client’s LiteSwitch deployment. This is the same cluster that serves bid traffic.