Admin API: settings

16 methods work with the same things as the Settings («Настройки») section of the panel: general parameters and bot lists, geo profiles, exchange rates and audit log cleanup. All methods need a token with Full access («Полный доступ») (full).

Authorization is described on the Admin API: overview and authorization page, and the format of requests and responses and the common error codes on the Request, response and error format page.

Settings and revision

The settings are one JSON object with keys and the service field _revision. The revision increases by 1 with every save. The tracker uses it to reject a write on top of someone else's changes.

s2s_timeout_sec is the time in seconds for one send of an outgoing S2S postback. It does not apply to Facebook Conversions API events.

What each parameter means is explained on the Settings: general parameters and bot lists and Bot detection and custom bot lists pages.

Get the settings

GET /api/v1/settings

Returns the saved keys and _revision. There are no parameters. A key that has never been saved is absent from the response — its default value applies. Until the settings have been changed, _revision is 0.

{"s2s_timeout_sec": 10, "report_attribution": "click", "allow_php": true, "bot_ua": ["MyScanner"], "bot_ip": ["203.0.113.0/24"], "_revision": 7}

Change the settings

PATCH /api/v1/settings
PUT /api/v1/settings

Changes only the keys you pass; the rest are kept. The bot_ua and bot_ip arrays are replaced entirely.

PUT without _revision saves the values without checking the revision. With _revision, both methods work the same way.

Response — code 200 and all settings with the new _revision.

curl -X PATCH https://panel.example.com/api/v1/settings \
  -H "Api-Key: <token>" \
  -H "Content-Type: application/json" \
  -d '{"_revision":7,"s2s_timeout_sec":15,"bot_ip":["203.0.113.10","203.0.113.0/24"]}'

Geo profiles

A geo profile is a named set of countries for the “GEO” («Гео») condition in a stream. Working with profiles in the panel is described on the Geo profiles page.

Get the list of profiles

GET /api/v1/geo-profiles

Returns an array: first the 14 built-in profiles, then the custom ones in alphabetical order. There are no parameters. Built-in profiles cannot be changed or deleted.

Create a profile

POST /api/v1/geo-profiles

Response — code 200 and the profile object with id.

curl -X POST https://panel.example.com/api/v1/geo-profiles \
  -H "Api-Key: <token>" \
  -H "Content-Type: application/json" \
  -d '{"name":"Tier 1","countries":["US","CA","GB","AU"]}'

Change a profile

PUT /api/v1/geo-profiles/{id}

Replaces the name and the country list of the {id} profile. The body fields are the same as when creating, and both are required. Response — code 200 and the profile object.

Errors of creating and changing:

Delete a profile

DELETE /api/v1/geo-profiles/{id}

Deletes a custom profile. Response — code 204 with no body. Streams that already have the profile's countries inserted do not change. If there is no such profile — 404 with code not_found. If {id} is not a UUID — 400 with code bad_request.

Exchange rates

A rate is how many USD one unit of a currency costs on a date. How the tracker chooses a rate for conversion is described on the Currencies and rates page.

Get the rate history

GET /api/v1/currency-rates

Returns an array of manual and automatic rates — up to 1000 rows, newest dates first. There are no parameters.

Add a manual rate

POST /api/v1/currency-rates

Response — code 201 and the added rate with source = manual.

{"currency": "EUR", "day": "2026-10-01", "usd_rate": 1.1, "source": "manual"}

Get the state of automatic rates

GET /api/v1/currency-rates/provider

There are no parameters. Response — code 200 and an object:

Turn automatic rates on or off

PUT /api/v1/currency-rates/provider

Response — code 200 and the state object. Without the automatic field or with a body that is not JSON — 422 with code validation and the message Укажите режим обновления курсов (specify the rate update mode).

Update the rates now

POST /api/v1/currency-rates/refresh

Requests rates from the source outside the schedule. There is no body. The source is polled no more than once a minute: a repeated request made earlier returns the current state. Response — code 200 and the state object.

If the source did not respond — 502 with code currency_provider. The saved rates keep applying as long as they are no older than 7 days.

Audit log cleanup

Cleanup deletes old entries of the audit log and CSV exports whose term has expired. Before a one-time cleanup and before turning on auto-cleanup, you need a preview: it returns a token and a before boundary, which you pass in the next request. Rules and terms are described on the Data retention and audit log cleanup page.

Get the cleanup state

GET /api/v1/retention/status

There are no parameters. Response — code 200 and an object:

Preview the cleanup

POST /api/v1/retention/preview

Counts how many entries the cleanup will affect. Deletes nothing.

Response — code 200:

Run the cleanup

POST /api/v1/retention/apply

Response — code 200 and an object with the fields before, audit_rows, expired_exports — how many were deleted. One request deletes up to 10000 audit entries and up to 100 exports. If more remain, repeat the request: within 15 minutes the same before and token work, after that you need a new preview.

curl -X POST https://panel.example.com/api/v1/retention/apply \
  -H "Api-Key: <token>" \
  -H "Content-Type: application/json" \
  -d '{"days":90,"before":"2026-07-06T12:00:00Z","token":"<token from the preview>"}'

Save the auto-cleanup rule

PUT /api/v1/retention/policy

Turns the daily auto-cleanup on or off, or changes its term.

Response — code 200 and an object with enabled, audit_days, revision, next_run. revision in the response is 1 greater than the one you passed. After turning on, turning off or changing the term, next_run is in 24 hours.

Errors of the cleanup methods: