Campaign Agent

List Agents

Every agent belonging to the current user.

get/api/v1/agent/list

Request

Base URL: https://api.adrex.ai (the document declares no server; this is the origin it was published from)
URL: https://api.adrex.ai/api/v1/agent/list
Auth: HTTP bearer

Response

Successful Response

idinteger required

namestring

user_idinteger nullable

is_enabledboolean

interval_minutesinteger

allowed_actionsstring[]

What the agent may do: 'budget' to change daily budgets, 'pause' to pause campaigns.

max_budget_change_percentnumber

min_budgetnumber

max_budgetnumber

require_approvalboolean

target_campaign_idsstring[] nullable

Limit the agent to these campaigns. None means every campaign on connected accounts.

target_cpanumber nullable

target_roasnumber nullable

budget_currencystring nullable

ISO code the budget limits and target CPA were entered in. Recorded so a later account in a different currency cannot silently reinterpret them — 10000 meant as dollars is a crippling ceiling read as rupees.

business_contextstring nullable

created_atstring date-time nullable

updated_atstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.