Entities
Common API is working with supports the following top-level entities (some entities are optional in and should be used only in case your solution does support them).
| ID | Description |
|---|
advertisers | Advertisers |
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 |
...
| 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 are using use the following required variables. Pagination , and output control options are also available.
| 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: user needs to have "API access" role or to be admin. |
Examples
Get all entities
| Блок кода |
|---|
|
GET https://ui.getintent.com/api/v2/<entity>/all?token=<token> |
Response:
| Блок кода |
|---|
|
{
"data": {
"<entity id>" => {<entity data>},
...
}
} |
List entities
| Блок кода |
|---|
|
GET https://ui.getintent.com/api/v2/<entity>/list?token=<token>&custom_fields=<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.
...
| Блок кода |
|---|
|
curl -X DELETE https://ui.getintent.com/api/v2/<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.