Common entities API

Available Entities

RTB data model is working with the following entities:

ID	Description
advertisers	Advertisers (Advertiser related objects have to be managed by Advertiser API.)
segment_definitions	Common segments
reference_tables	Contains additional information and variety settings
domains_lists	Common domain lists
snippets	Common snippets

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 value can be found at "my settings" user's menu. Important: token has to belong to Admin user.

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

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

Code Sample "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>

Parameter	Description	Available at, method	Values	By default	Example
mode	Affects on list's view. 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	all, list	0 - old version (deprecated). 1 - new version.	0	../list?token=<token>&mode=1
custom_fields	Includes all listed object's fields in output for "list" method	list	Listed by comma additional fields.	null	../list?token=<token>&custom_fields=starts,ends
page_limit	Limits count of items per request. Realizes pagination. If "page_limit" parameter is used, then "mode" property's value becomes mode=1 automatically.	all, list	Count of items per one page.	null	../list?token=<token>&page_limit=10
page	Current page. Works with "page_limit" method together only.	all, list	Current page in output.	null	../list?token=<token>&page_limit=10&page=2

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

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 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>

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

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 https://ui.getintent.com/api/v1/<entity>/delete/<entity_id>?token=<token>

Example:

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