Просмотреть исходный

Entities

Common API is working with the following top-level entities (some entities are optional in 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 variety 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 are using the following required 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.

Examples

Get all entities

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

List entities

GET https://ui.getintent.com/api/v1/<entity>/list?token=<token>&custom_fields=<field1>,<field2>,...

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.

PUT https://ui.getintent.com/api/v1/<entity>/new?token=<token>

Example:

curl --data '{"name": "title",...}' -X PUT https://ui.getintent.com/api/v1/<entity>/new?token=<token>

Get entity attributes

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 entity

Use PUT request type, request body should contain appropriate JSON object.

PUT https://ui.getintent.com/api/v1/<entity>/edit/<entity_id>?token=<token>

Example:

curl --data '{"name": "new title",...}' -X PUT https://ui.getintent.com/api/v1/<entity>/edit/<entity_id>?token=<token>

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