...

For API Access

To receive API access, please reach out to Getintent sales team – us-sales@getintent.com. 

Change log

Introduction

This document describes the API of GetIntent DSPGetintent platform. The API consists of two three major partsservices:

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

...

• available reporting  information campaign performance, available inventory, etc.

General approach

...

API is build built 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:\and support standard GET/PUT/DELETE methods over HTTP 1.1 protocol.

GET	read/retrieve
PUT	create/add/update/modify
DELETE	delete

API endpoints

API URLs have the following pattern:

http://ui.getintent.com/api/v2/<object_type>/<action>(/<id>)?token=<token>

API response codes

API always returns valid JSON as output, the following HTTP response codes are supported:

API error example:

{
    "error": 1,
    "code": 403,
    "msg": "Unavailable AdData object 'aadvertisers'"
}

JSON data model

RTB data model contains several entities, each entity has it’s own JSON representation with name and id:

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

Also some object 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.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.

Also those methods should be used for Advertiser's settings management.

Important! All variables are required.

Variables

Available Entities

Methods

Entity's objects list

GET https://ui.getintent.com/api/v1/<entity>/list?token=<token>  

Returns System and Common <entity> type Objects list.

"id" and "name" fields will be returned for each object by default.

Here is example of such "list" method:

{
	"137": {
		"id": 137,
		"name": "Test campaign!"
	},
 
	...
	"4452": {
		"id": 4452,
		"name": "test"
	}
}

If any additional fields are needed at the list just put all of them separated by comma at GET custom_fields parameter. 

In case you need to get list of objects with absolutely all existing fields, just use "all" method as below:

GET https://ui.getintent.com/api/v1/<entity>/all?token=<token>

Additional parameters

API output

API output can be controlled by the following additional parameters and headers

Additional parameters controlling pagination/formatting

Additional headers

D, d M Y H:i:s GMT

Create an Entity

PUT https://ui.getintent.com/api/v1/<entity>/new?token=<token> 

Use PUT request type. At JSON with object's structure have to be at request's body.

Example:

curl --data '{"name": "title"}' -X PUT https://ui.getintent.com/api/v1/<entity>/new?token=<token>

Get an Entity

GET https://ui.getintent.com/api/v1/<entity>/get/<entity_id>?token=<token>

Example:

curl -X GET https://ui.getintent.com/api/v1/<entity>/get/<entity_id>?token=<token>

Additional headers

D, d M Y H:i:s GMT

Update an Entity

PUT https://ui.getintent.com/api/v1/<entity>/edit/<entity_id>?token=<token>

Use PUT request type. At JSON with object's structure have to be at request's body.

Example:

curl --data '{"name": "new title"}' -X PUT https://ui.getintent.com/api/v1/<entity>/edit/<entity_id>?token=<token>

Delete an Entity

DELETE https://ui.getintent.com/api/v1/<entity>/delete/<entity_id>?token=<token>

Example:

{
    "data": {
        "921": {
            "id": "921",
            "name": "test_campaign"
        },
        "1400": {
            "id": "1400",
            "name": "1"
        }
    },

    "pages": {
        "total_elements": "6",
        "total_pages": 3,
        "current_page": 1,
        "previous_page": false,
        "next_page": 2,
        "page_size": 2,
        "offset": 0
    }
}

curl -X DELETE https://ui.getintent.com/api/v1/<entity>/delete/<entity_id>?token=<token>