Change log

Introduction

This document describes the API of GetIntent RTBSuite platform. The API consists of two major parts:

• Campaign management API. This API allows to create and edit advertising campaigns along with related entities (creatives, segments and etc)
• Reporting API. This part of API allows to get statistical information about campaign that are already running

General approach: Methods and Objects

API is built as JSON RESTful service and support standard GET/PUT/DELETE methods. Each API object entity has it’s own JSON representation. Each JSON entity object has a name and an id:

{
	id: 1,
	name: "<name>",
 	...
}                                    

Also some objects may belong to a specific advertiser, in this case advertiser_id field would be required

{
	id: 1,
	name: "<name>",
	advertiser_id: 6
 	...
}                         

The general URL API pattern is: 

http://ui.project.domain/api/v1/<object_type>/<action>(/<id>)?token=<token>

Where <token> is authentication token (can be obtained through user settings in UI)

Controlling API output

API output is controlled by the following additional parameters and headers