Change log
| Date | API version | Change |
|---|---|---|
| 4 September 2015 | v1.33 | Added authentication reference |
| 24 September 2015 | v1.35 | Add "last-modified" support |
| 10 October 2015 | v1.36 | Added object "forecast" for advertiser |
| 5 November 2015 | v1.37 | Campaigns, campaign_groups, creatives, sites added to common objects |
Introduction
This document describes the API of GetIntent DSP. 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
The main objective of this API is campaign management API.
General approach: object and methods
API is build as JSON RESTful service. Each object has it’s JSON representation and could be retrieved using get method. Also list, update and new are available.
Each type of JSON object has name and id. The structure is as follows:\
| Блок кода | ||
|---|---|---|
| ||
{
id: 1,
name: "<name>",
...
} |
Also some object may belong to 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.getintent.com/api/v1/<object_type>/<action>(/<id>)?token=<token> |
Where token is authentication token (it could be obtained through user settings in UI)
Common and System Objects
Here you'll find API examples for work with Common and System objects.
...