История страницы

...

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 RTBSuite Getintent 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 runningavailable reporting  information campaign performance, available inventory, etc.

General approach

...

API is built as JSON RESTful service and support standard GET/PUT/DELETE methods . Each API object 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 . Each JSON entity object has a with name and an id:

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

...

{
	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 (can be obtained through user settings in UI)

...

output

API output is 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

{
    "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
    }
}

...