| Оглавление |
|---|
Entities
Common API supports the following top-level entities (some entities are optional and should be used only in case your solution does support them).
| ID | Description |
|---|---|
campaigns | Campaigns |
campaign_groups | Campaign groups sharing common budget |
creatives | Creatives |
sites | Sites |
segment_definitions | Common segments |
reference_tables | Contains additional information and various settings |
domains_lists | Common domain lists |
snippets | Common snippets |
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.
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.
...
| Variable | Description |
|---|---|
| <entity> | Object type (reference_tables, segment_definitions |
| , ...) | |
| <entity_id> | Object's ID |
| <token> | Token for API access. |
| This value can be found |
| in " |
| My settings" user's menu |
| . |
Available Entities
| ID | Description |
|---|---|
| advertisers | Advertiser and its settings. Important: Advertiser's objects have to be managed at Advertiser's level |
| segment_definitions | Common segments |
| reference_tables | Contains additional information and variety settings |
| domains_lists | Common domain lists |
| snippets | Common snippets |
Methods
Entity's objects list
Examples
Get all entities
| Блок кода | ||
|---|---|---|
| ||
GET https://ui.getintent.com/api/v1v2/<entity>/listall?token=<token> |
Returns System and Common <entity> type Objects list.
"id" and "name" fields will be returned for each object by default.
<token> |
ResponseHere is example of such "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
| Блок кода | ||
|---|---|---|
| ||
GET https://ui.getintent.com/api/v1/<entity>/all?token=<token> |
Additional parameters
...
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
...
0 - old version (deprecated).
1 - new version.
...
v2/<entity>/list?token=<token>& |
...
custom_fields |
...
Includes all listed object's fields in output for "list" method
...
Limits count of items per request.
Realizes pagination.
If "page_limit" parameter is used, then "mode" property's value becomes mode=1 automatically.
...
=<field1>,<field2>,... |
Response:
| Блок кода | ||
|---|---|---|
| ||
{
"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.
...
Additional headers
| Parameter | Description | Available at, method | Values | By default | Example |
|---|---|---|---|---|---|
| if-modified-since | Return header HTTP 304 Not Modified | list | Date in specify formatD, d M Y H:i:s GMT | null | if-modified-since: Fri, 18 Sep 2015 10:34:37 GMT |
Create an Entity
| Блок кода | ||
|---|---|---|
| ||
PUT https://ui.getintent.com/api/v1v2/<entity>/new?token=<token> |
...
Example:
| Блок кода | ||
|---|---|---|
| ||
curl --data '{"name": "title",...}' -H 'Content-Type: application/json' -X PUT https://ui.getintent.com/api/v1v2/<entity>/new?token=<token> |
Get
...
entity attributes
| Блок кода | ||
|---|---|---|
| ||
GET https://ui.getintent.com/api/v1v2/<entity>/get/<entity_id>?token=<token> |
...
| Блок кода | ||
|---|---|---|
| ||
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 | get | Date in specify formatD, 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.
| Блок кода | ||
|---|---|---|
| ||
PUT https://ui.getintent.com/api/v1v2/<entity>/edit/<entity_id>?token=<token> |
...
Example:
| Блок кода | ||
|---|---|---|
| ||
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
| Блок кода | ||
|---|---|---|
| ||
DELETE https://ui.getintent.com/api/v1v2/<entity>/delete/<entity_id>?token=<token> |
...
| Блок кода | ||
|---|---|---|
| ||
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.