Setup a Campaign

Learn how to setup a new campaign with the Cuebiq API.

Introduction

Campaigns are the overarching container for all reports and pixels. Every campaign can be associated with multiple reports and each report is associated with a single pixel. This guide will walk through the steps to set up a new campaign and autofill data between your DSP and Clara.

Prerequisites

In order to create campaigns you need a token and refresh token request. To get these tokens, you will need to request access to the API. Once access has been approved, Cuebiq will provide a client_id and client_secret as well as a customerId. A token will allow you to call every available endpoint in the Clara API.

Creating a campaign

To create a campaign, call the following endpoint with the required parameters:

 POST   /v1/customers/{customerId}/campaigns

See the endpoint documentation for more information and a sample request and response.

Campaign Parameters 

Creating a report

Once you have created a campaign, you should create a report to monitor the performance of the campaign. Depending on the media you are serving, you should select the matching report type by setting the isInAppOnly parameter.

Note: The report will automatically adopt the flight dates of the campaign and each report can have no more than 1 pixel assigned.

 

Create a campaign by calling the following endpoint with the required parameters:

 POST   /v1/customers/{customerId}/campaigns/{campaignId}/reports

See the endpoint documentation for more information and a sample request and response.

Report Parameters

Setting up a pixel for the campaign

As stated before, each report must have 1 pixel. For information about pixel set up and certification please see the following articles in our knowledge base:

Setting up the pixel guide.

Pixel certification process

Need More Help?

Can’t find an answer or having an issue with the API? Visit our FAQ or request support for more help.