...
All API methods are using the following variables (pagination, 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 value can be found at "my settings" user's menu. Important: token has to belong to Admin user. |
...
"id" and "name" fields will be returned for each object by default.
Here is example of such "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> |
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.
...
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.
...
.
...
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/v1/<entity>/new?token=<token> |
...
| Блок кода | ||
|---|---|---|
| ||
curl -X GET https://ui.getintent.com/api/v1/<entity>/get/<entity_id>?token=<token> |
Additional headers
...
Return header HTTP 304 Not Modified
without content, if data has not updated since this date
...
D, d M Y H:i:s GMT...
Update an Entity
| Блок кода | ||
|---|---|---|
| ||
PUT https://ui.getintent.com/api/v1/<entity>/edit/<entity_id>?token=<token> |
...