Available Entities
Common API is working with the following top level 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 |
REST API Methods
API methods
| Method | Description |
|---|
| all | Get all entities |
| list | List entities range |
| get | Get specific entity properties |
| new | Create a new entity |
| edit | Update specific entity |
| delete | Delete specific entity |
All API methods are using the following required variables. Pagination, output control options are also available.
API 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. |
API list
Get all entities
| Блок кода |
|---|
|
GET https://ui.getintent.com/api/v1/<entity>/all?token=<token> |
Entity's objects list
| Блок кода |
|---|
|
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.
Create an entity
| Блок кода |
|---|
|
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 an entity
| Блок кода |
|---|
|
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> |
Update an entity
| Блок кода |
|---|
|
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 an entity
| Блок кода |
|---|
|
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> |