API Documentation

API integration and documentation

Puneet Gupta avatar
Written by Puneet Gupta
Updated over a week ago

Last Update: June, 2023

Kayzen platform has a modular architecture built using API's. Users can leverage Kayzen's event, audience and reporting API's to get more out of the platform

You can use Kayzen Reporting API to programmatically query and access your campaign reporting and performance data.

Use case: By leveraging Kayzen reporting API, for instance, you can load this data in your data aggregation platform to visualize and create custom reports from different channels in one place

If you want to track custom events on Kayzen, you can use Kayzen Events API. These events will be displayed in the Kayzen UI (Dashboard, Campaign list, Campaign detail pages). 

Event API allows you to pass both attributed events with data generated by campaigns run via Kayzen as well as non-attributed events. You can use non-attributed events to create an audience using our customer audience builder generating retargeting lists, suppression lists or to measure incrementality in your retargeting campaigns.

Use Cases: 

  1. Passing events that aren’t tracked by your MMP. In an eCommerce app, if you want to record an event which gives the total amount paid by customers for every order. 

  2. In-ad events. If you want to track interaction events in your playable (or any other HTML) creatives, you can add the event callbacks in your creative and send them to Kayzen to measure user engagement within creatives and improve them based on this data.

  3. You are using your own attribution platform. If you use an in-house attribution platform, you can use Events API to pass all the events which you want to post back to Kayzen.

  4. Web campaigns. If you would like to track conversion from web pages (e.g., registration through a mobile website), you can also use Events API. 

Note: All the above are just an example of that particular use case.

You can create an audience and add/remove users from this audience programmatically by leveraging Kayzen's Audience API

Use Case: You created an audience of users in your BI tool based on your internal custom logic. This is useful if these users are created based on events that you are not sending to your MMP or Kayzen. You can call the Audience API and add/remove users from the audience in real-time.

You can create Tracker Asset's or change the URL's in the Tracker Asset's programmatically using this API

Use Case: If your campaign structure requires multiple url's and hence multiple tracker assets, then the api can be used to create such tracker assets in a quick way programmatically. If you need to edit the URL's of a tracker asset, the api allows to do so in a seamless and less error prone way.

You can list, view, create or edit App Lists's programmatically using API's.

Use Case: App lists containing specific app bundles are attached as whitelists or blacklists to campaigns. These app bundles are a key to allow marketers to achieve their performance goals. Therefore, we want to provide easier ways for making faster changes to the app lists through API's apart from the seamless user experience on the UI. These API's will enable you to list, view or update existing app lists or create new app lists.

Campaign Management API's

Using these API's, you can edit your campaign properties in order to improve the campaign performance. The properties that can be changed are Target Bid, Daily Budget and Total Budget. The campaign should have already been created and you will only be able to edit the previously set values.

You can enable the Bid Multiplier at campaign level and edit bid multiplier values for different targeting fields like apps, auction type, exchanges etc programmatically using bid multiplier API's

Use Case: There are multiple ways in which you can use Bid multiplier API to streamline your campaign optimization processes and improve campaign performance. For instance, the api can be used for automation of campaign optimization tasks or to build a bid optimization algorithm that executes automatic bid changes for different pockets of inventory based on predefined rules.

Campaign & Creative Status change API

These API's will enable you to change the status of campaign's and creative's from Running to Paused or vice versa. The API's are helpful when you are managing the campaigns from your system without having to open the Kayzen UI. This is typically the situation when you are observing the campaign and creative performance with the help of Reporting API's and taking decisions to change the status of particular campaigns and creatives.

For more details around API documentation please visit our API documentation page

Did this answer your question?