Admin API: campaigns

This page covers 15 methods for working with campaigns. All methods require a token with Full access («Полный доступ») (full) in the Api-Key header. Authorization is described on the Admin API: overview and authorization page, and the common request and error format on the Request, response and error format page.

Campaign object

The create, read, update and copy methods return the same object. The fields in the table are passed in the body on creation and update.

In s2s_postbacks, the status field is a status without spaces, up to 32 characters, or * for all statuses. The url field is a full http:// or https:// address up to 2048 characters without spaces.

Read-only fields:

• id — campaign ID, UUID;
• seq — sequence number, the same as in the ID column in the panel;
• workspace_id — team ID;
• owner_id — owner. When created with a token, the token's creator; not accepted from the request body;
• created_at — creation time;
• can_edit — whether the user can change the campaign; present in list and read responses.

Reading

List campaigns

GET /api/v1/campaigns

Returns the team's campaigns, newest first.

Response 200: an object with the items array and the total number — how many campaigns match the conditions regardless of limit.

curl "https://panel.example.com/api/v1/campaigns?state=active&limit=100" \
  -H "Api-Key: <token>"

Get a campaign

GET /api/v1/campaigns/{id}

Returns one campaign by its id. Response 200 — a campaign object. Error: 404 not_found.

Creating and editing

Create a campaign

POST /api/v1/campaigns

Creates a campaign. Only the name field is required; the others get the default values from the table above.

curl -X POST https://panel.example.com/api/v1/campaigns \
  -H "Api-Key: <token>" \
  -H "Content-Type: application/json" \
  -d '{"name":"FB · Sweeps US","cost_model":"cpc","cost_value":0.05,"uniqueness_method":"ip_ua","uniqueness_ttl":24,"group_name":"Sweeps"}'

Response 201 — the created campaign object with the assigned id, seq and alias. Errors: 400 bad_request, 409 conflict, 422 validation — the messages are in the Errors section.

Streams are added with separate methods — see Admin API: streams.

Edit a campaign

PUT /api/v1/campaigns/{id}

Changes the fields you pass. Fields not in the body keep their previous values.

• The s2s_postbacks list changes only if an array is passed. The array you pass replaces the whole list; an empty array removes all addresses.
• The params array and the cloak_config object are also replaced as a whole.

curl -X PUT https://panel.example.com/api/v1/campaigns/5b0c6a1e-3d0f-4a52-9c1b-7f2f1f3f8a10 \
  -H "Api-Key: <token>" \
  -H "Content-Type: application/json" \
  -d '{"state":"paused"}'

Response 200 — the campaign object after the change. Errors: 400 bad_request, 404 not_found, 409 conflict, 422 validation.

Archive a campaign

DELETE /api/v1/campaigns/{id}

Moves the campaign to the archived state. The record, streams and statistics are kept, and the campaign appears in the trash. Response 204 with no body. Error: 404 not_found.

You can bring the campaign back with the restore method of the trash or with a PUT request with {"state":"active"}. What happens to traffic is described on the Campaign archive and trash page.

Clone a campaign

POST /api/v1/campaigns/{id}/clone

Creates a copy of the campaign with all its streams. No body is needed.

• · копия (“copy”) is appended to the name.
• A random alias is generated.
• The copy is created in the paused state; streams keep their states.
• The owner, domain, source, parameters and postbacks are carried over unchanged.

Response 201 — the new campaign object. Errors: 404 not_found; 422 validation if the streams contain an unknown filter or an unavailable offer or landing page.

Team member access

Access gives a team member a view of the campaign and its statistics. More on the Campaign access and “Share” page.

Who the campaign is shared with

GET /api/v1/campaigns/{id}/shares

Response 200: an object with the user_ids array — IDs of the users who can view the campaign. Error: 404 not_found.

Set the access list

POST /api/v1/campaigns/{id}/shares

Replaces the whole list.

Response 204 with no body. Errors: 400 bad_request, 404 not_found. User IDs are returned by the list in Admin API: users.

Target checks

What the checks and messages mean is described on the Campaign target diagnostics and monitoring page.

Check the target configuration

GET /api/v1/campaigns/{id}/target-health

Checks the offers and landing pages of active streams without network requests: whether the target exists, whether an address is set, whether a hosted page's archive is uploaded.

Response 200: the items array and network_checked set to false. Item fields:

• stream — stream name;
• kind — offer, lander or stream;
• id, name — target ID and name. For an item with kind stream, id holds the stream ID, and name is empty;
• state — ok, warning or error;
• message — explanation, for example Конфигурация доступна (configuration available) or Оффер не активен (offer not active).

Error: 404 not_found.

Monitoring state

GET /api/v1/campaigns/{id}/target-monitor

Response 200: enabled — whether monitoring is on, and runs — up to 20 latest checks, newest first. A check has id, checked_at and items in the same format as target-health. After a network request, an item gets http_status and duration_ms — response time in milliseconds. Error: 404 not_found.

Turn monitoring on or off

PUT /api/v1/campaigns/{id}/target-monitor

Response 200 — the same object as the state method returns. Errors: 404 not_found; 422 validation with the message нужно enabled: true или false (enabled must be true or false).

Click and conversion logs

Both logs return records for a period, newest first. Common parameters:

A from or to value in a different format is ignored: the default value is used.

Response 200: the items array, total — the number of records that match the request conditions, limit — page size.

Errors of both methods: 404 not_found; 400 report_error — the statistics query failed, the cause is in message; 503 no_analytics — statistics are unavailable.

Click log

GET /api/v1/campaigns/{id}/clicks

Additional parameters:

Click fields: subid, ts, ip, campaign_id, stream_id, source_id, offer_id, lander_id, country, region, city, isp, connection_type, device_type, os, os_version, browser, browser_version, user_agent, referrer, lang, is_bot, is_unique, cost, sub_ids, tokens.

sub_ids and tokens are “name — value” objects. The values of token, access_token, capi_token, sub_id_12 and values that start with EAA are replaced with ***.

curl "https://panel.example.com/api/v1/campaigns/5b0c6a1e-3d0f-4a52-9c1b-7f2f1f3f8a10/clicks?from=2026-10-01T00:00:00Z&to=2026-10-02T00:00:00Z&limit=500&page=1" \
  -H "Api-Key: <token>"

Searching for a click across all campaigns is described on the Admin API: logs and diagnostics page.

Conversion log

GET /api/v1/campaigns/{id}/conversions

Each conversion is shown as one row with its latest status. A conversion is identified by the “click and txid” pair.

Conversion fields: subid, ts — time of the last change, status, payout, revenue, offer_id, txid.

Campaign groups

A group is a text label in the group_name field. You can assign a group to a campaign with the campaign update method. The methods below change the label for all campaigns of the group at once.

Rename a group

PUT /api/v1/campaign-groups?name=<current name>

In the query string, name is the group's current name; in the body, name is the new one. Both are required. If the new name matches an existing group, the groups are merged.

curl -X PUT "https://panel.example.com/api/v1/campaign-groups?name=Sweeps" \
  -H "Api-Key: <token>" \
  -H "Content-Type: application/json" \
  -d '{"name":"Sweeps US"}'

Response 200: {"updated": 3} — the number of changed campaigns. Error: 422 validation.

Delete a group

DELETE /api/v1/campaign-groups?name=<name>

Removes the label from the group's campaigns. The campaigns themselves remain. Response 200: an object with the updated field. Error: 422 validation with the message name обязателен (name is required).

Errors

Common codes are on the Request, response and error format page. Messages of the methods on this page: