API

The Kleio API has four main endpoints: the ads and the related products resources, the auctions endpoint, and finally the tracking endpoint. On this page, we give an overview of how they relate.

Ad and product resource

In Kleio everything centers around the concept of an ad. An ad signals your intent to promote a product and how much someone is willing to pay to have a product promoted. What makes Kleio powerful is that you can have any number of ads for the same product. This, in combination with the ability to the ads, allows you to, for example, differentiate the amount you want to bid by the locations where it is shown or by the demographics of the user who is to see it.

Products and product ids

You cannot manually create a product in Kleio. Products come into existence as a result of you creating an ad to promote it. When creating an ad you will be asked to provide the identifier of the product it is associated with. This identifier should be the same used in your systems when referencing the product. For example, if you are selling bikes, and you internally identify a given bike by the identifier 1234, then this is also what you should use in Kleio. This way you will be able to directly know which product to showcase when you get returned a winning bid by the auction endpoint.

Auctions and Tracking

The auction and tracking endpoints do not refer to resources at all. They both operate on the ad resource. When you are about to render a list of products in your service, you call the Kleio auction endpoint and it will in turn let you know which product to show as a promoted product. The tracking endpoint in turn allows you to signal back to Kleio whether a given promoted product was seen and whether it converted (what conversion means in your context you decide yourself). Making correct use of the tracking endpoints is more than pure cosmetics. They are what allow Kleio to run auctions that optimize the amount of revenue your system can generate through preferentially promoting products that are also likely to convert and when doing so maximize the money you earn.