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

Оглавление

...

Entities

RTB data model is working with Common API supports the following entities:top-level entities (some entities are optional and should be used only in case your solution does support them).

ID	Description

advertisersAdvertisers (Advertiser related objects have to be managed by Advertiser API.)


`campaigns`	Campaigns
`campaign_groups`	Campaign groups sharing common budget
`creatives`	Creatives
`sites`	Sites
`segment_definitions`	Common segments
`reference_tables`	Contains additional information and

variety

various settings
`domains_lists`	Common domain lists
`snippets`	Common snippets

REST API Methods

Methods

Method	Description
`all`	Get all entities
`list`	List entities
`get`	Get specific entity info
`new`	Create a new entity
`edit`	Update specific entity
`delete`	Delete specific entity

Variables

All API methods use the following required variables. Pagination and output control options are also available.All API methods are using the following variables:

Variable	Description
<entity>	Object type (reference_tables, segment_definitions

и тд

, ...)
<entity_id>	Object's ID
<token>	Token for API access.

Its

This value can be found

at

in "

my

My settings" user's menu.

Important: token has to belong to Admin user.

Examples

Get all entities

Блок кода

language	bash

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

Entity's objects list

Блок кода

language	bash

GET https://ui.getintent.com/api/v1/<entity>/list?token=<token>&custom_fields=<starts>,<ends>

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" methodResponse:

Блок кода

language	js	title	Code Sample "list" method

{
	"137    "data": {
		"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:

       "<entity id>" => {<entity data>},
       ...
    }
}

List entities

Блок кода

language	bash

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

Additional parameters

...

list

...

Old version: all collection will be returned at root (deprecated)

New version: all collection will be placed to data node

Value recommend to use always: 1

...

0 - old version (deprecated).

1 - new version.

...

?token=<token>&

...

custom_fields

...

Includes all listed object's fields in output for "list" method

...

=<field1>,<field2>,...

Response:

Блок кода

language	js

{
    "data": {
       "<entity id>" => {<entity data>},
       ...
    }
}

List method by default returns only object's "id" and "name" fields, additional fields in output are controlled by "custom_fields" parameter.

Create an entity

Use PUT request type, request body should contain appropriate JSON object.

...

Limits count of items per request.

Realizes pagination.

If "page_limit" parameter is used, then "mode" property's value becomes mode=1 automatically.

...

Additional headers

Parameter	Description	Available at, method	Values	By default	Example
if-modified-since	Return header HTTP 304 Not Modified without content, if data has not updated since this date	list	Date in specify format D, d M Y H:i:s GMT	null	if-modified-since: Fri, 18 Sep 2015 10:34:37 GMT

Create an Entity

Блок кода

language	bash

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

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

Example:

Блок кода

language	bash

curl --data '{"name": "title",...}' -H 'Content-Type: application/json' -X PUT https://ui.getintent.com/api/v1v2/<entity>/new?token=<token>

Get

...

entity attributes

Блок кода

language	bash

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

...

Блок кода

language	bash

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

Additional headers

Parameter	Description	Available at, method	Values	By default	Example
if-modified-since	Return header HTTP 304 Not Modified without content, if data has not updated since this date	get	Date in specify format D, d M Y H:i:s GMT	null	if-modified-since: Fri, 18 Sep 2015 10:34:37 GMT

Update an Entity

Update entity

Use PUT request type, request body should contain appropriate JSON object.

Блок кода

language	bash

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

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

Example:

Блок кода

language	bash

curl --data '{"name": "new title",...}' -H 'Content-Type: application/json' -X PUT https://ui.getintent.com/api/v1v2/<entity>/edit/<entity_id>?token=<token>

Delete

...

entity

Блок кода

language	bash

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

...

Блок кода

language	bash

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

JSON File size limits

Currently, Getintent platform API has a limitation of 3 MB for each campaign JSON file. Successful files processing of larger size is not guaranteed.

Дерево страниц

Сравнение версий

Старая версия 9

Новая версия Текущий

Ключ

Entities

REST API Methods

Methods

Variables

Examples

Get all entities

Entity's objects list

List entities

Additional parameters

Additional headers

Create an Entity

Get

entity attributes

Additional headers

Update an Entity

Update entity

Delete

entity

JSON File size limits