API Advertisers

To authorize in the system via API using a Bearer Token, add an "Authorization" header with the value "Bearer X" to your request, where "X" is your personal token. The token is available in the advertiser's dashboard under "Profile and settings". The token has no expiration. The token can be reset via POST /api/users/token-reset.

Base URL:

Swagger documentation: https://partners.kadam.net/api-doc/
​ Common response format:

{ } "success": true, "code": 0, "msg": {}, "data": { ... }

On error success = false, field msg contains the error description.
​ Pagination and sorting (common parameters for list endpoints):

To get the data of the current account, use the GET /me method. It returns the account ID, balance, currency, registration date and time zone. Email and name are not returned.

Example request:

For a quick balance check (for example, for low-balance alerts), use the GET /finances/balance method. It returns only the balance and the account currency.

Example request:

To get the list of campaigns the method POST /campaigns is used.

Example request:
​

Response:
​

{ "success": true, "data": { "total": 124, "items": [ { } ] } }

To fetch full campaign data, use the method GET /campaigns/{id}
Path parameter:

Example request:
​

The response returns all campaign fields in the same format accepted by PUT /campaigns/{id}/update. Convenient for round-trip editing: GET → modify a field → PUT the full payload back.

To create a campaign, use the method POST /campaigns/create
Content-Type: application/json The request body depends on the campaign type (field type):

Required common fields:

For dictionaries (countries, categories, push types, etc.) required for creation, use GET /campaigns/options?type={type}. Full schemas per format — see Swagger: https://partners.kadam.net/api-doc/#/Campaigns/post_campaigns_create

To update campaign parameters, use the method PUT /campaigns/{id}/update
​ Important: partial update is NOT supported. All fields (as in create) must be sent in the request, otherwise a validation error is returned. Typical flow: GET /campaigns/{id} → modify the field → PUT /campaigns/{id}/update with the full payload. Full schemas per format — see Swagger: https://partners.kadam.net/api-doc/#/Campaigns/put_campaigns__id__update

To update the bid of a single campaign, use the method PUT /campaigns/{id}/bid
Content-Type: application/json

Example request:
​

To update bids on multiple campaigns at once, use the method PUT /campaigns/bids

Example request:
​

For bulk status changes, the following methods are used:

Example request:
​

To fetch dictionaries (countries, categories, push types, payment models, etc.), use the method GET /campaigns/options
Query parameters:

Example request:
​

In addition to activation, pausing and archiving, the following bulk methods are available:

campaignIds — array of campaign IDs, array of int; required parameter.

Example request:

To create a copy of a campaign, use the POST /campaigns/{id}/copy method. Targeting, limits and bids are copied; statistics and spend are not. Copied materials always go through moderation again.

Example request:

The POST /campaigns/validate method runs the same checks as POST /campaigns/create but does not create anything. The request body is the same as for creation. Response 200 means the campaign would be accepted as is; error 422 lists the fields with errors.

The POST /campaigns/forecast method returns the dependence of the available traffic volume on the bid for the specified targeting, based on yesterday's auction data. Use it before creating a campaign or raising a bid.

If there was too little traffic for the specified targeting yesterday, the response contains an empty curve and hasEnoughData: false. This is not an error and does not mean that there will be no traffic.

Example request:

The PUT /campaigns/{id}/rss method sets the RSS feed from which a Native campaign imports creatives (for other formats the request returns error 422).

The import runs on a schedule, so a successful response means that the feed has been saved, not that the creatives have already been added.

The PUT /campaigns/{id}/easy-start method turns Easy Start on or off for a campaign — showing ads on a curated set of sites instead of the whole inventory. Parameter: enabled — bool; required parameter.

Example request:

The GET /dictionaries/{type} method returns one dictionary needed to create or update a campaign. Available types: campaign-types, browsers, platforms, devices, connection-types, categories, isps, conversion-templates, countries, regions, cities.

Additional query parameters: campaignType — campaign type; countryId — country (for regions); regionId — region (for cities); search — search string; page, perPage — pagination.

Example request:

To fetch the list of campaign folders, use the method POST /campaigns/folders The request body can be empty ({}) or include standard pagination/sorting fields. Example request:
​

To create a folder, use the method POST /campaigns/folders/create

Example request:
​

To manage a folder's limits and budget distribution, use the method PUT /campaigns/folders/{id}/settings
Path parameter: id — folder ID, int.

Example request:
​

The GET /campaigns/folders/{id} method returns the folder settings. The PATCH /campaigns/folders/{id} method changes the folder name and limits: name, limitsEnabled, groupDailyLimit, groupTotalLimit, groupSpendingEvenly.

Example request:

folderIds — array of folder IDs, array of int; required parameter.

Example request:

To fetch the list of materials, use the method POST /materials

Example request:
​

To fetch material data, use the method GET /materials/{id}
Path parameter: id — material ID, int. Example request:
​

To create a material, use the method POST /campaigns/{id}/materials
Path parameter: id — campaign ID.
Content-Type: multipart/form-data (image files are passed). The body depends on material type. Common fields:

Full schemas per format — see Swagger: https://partners.kadam.net/api-doc/#/Materials/post_campaigns__id__materials

To update a material, use the method PUT /campaigns/{id}/materials
Content-Type: application/json. Full schemas per format — see Swagger: https://partners.kadam.net/api-doc/#/Materials/put_campaigns__id__materials

For bulk status changes, the following methods are used:

Example request:
​

To fetch the banner size dictionary for creation, use the method GET /materials/options. Example request:
​

adsIds — array of material IDs, array of int; required parameter.

The POST /materials/copy method copies every listed material into every listed campaign (2 materials and 2 campaigns give 4 copies). Target campaigns must have the same format as the source one. Copies are created paused and go through moderation.

Example request:

The POST /materials/move method moves materials to another campaign with the same format and payment model. Moved materials lose their own country bids, are paused and go through moderation again.

The PUT /materials/bids method sets materials' own bids by country. The list fully replaces the materials' bids: countries not in the list use the campaign bid. All materials must belong to one campaign, and the countries must be targeted by this campaign. Not available for CPA Target campaigns.

Bulk upload is performed in two steps, each of which is processed asynchronously:

The GET /materials/{id}/test-conversion method returns a link for a test click on the material: the click writes click_id, substitutes the macros and redirects to the landing page in the same way as a real ad impression. This lets you check the postback setup end to end. For formats displayed in a frame, previewUrl is also returned.

Example request:

To fetch the list of audiences, use the method POST /audiences

Example request:
​

To fetch the list of campaigns and audiences available for S2S linking, use the method GET /audiences/create-options Query parameters:

To fetch audience data, use the method GET /audiences/{audiencesId}
Path parameter: audiencesId — audience ID, int.
Response shape depends on audience type (stat / pixel / S2S).

To create an audience, use the method POST /audiences/create
Content-Type: application/json Audience kind is specified by the type field:

Example (standard audience):
​

At least one of hasClicks / hasConversions / hasHolds / hasRejects must be true.
​ usersIds — array of user IDs for sharing the audience. Example (pixel audience):
​

Full schemas (AudienceStandardRequest, AudienceCodeRequest, AudienceS2SRequest) — in Swagger: https://partners.kadam.net/api-doc/#/Audiences/post_audiences_create

To update an audience, use the method PUT /audiences/{id}
Path parameter: id — audience ID, int.
Body is similar to creation (without the type field; type can only be changed by recreating). Details in Swagger.

To delete an audience, use the method DELETE /audiences/{id}
Path parameter: id — audience ID, int. Example request:
​

The GET /audiences/{id}/params and PUT /audiences/{id}/params methods get and save fixed parameter values that are substituted into the pixel or S2S code: event, paramStr, paramStr2, paramInt, paramInt2. They work only for pixel and S2S audiences and only for the audience owner. PUT replaces all values: a field that is omitted or passed as null is reset.

The POST /audiences/validate method checks the request body in the same way as POST /audiences/create but does not create anything. Ownership of the campaigns and audiences specified in the request is not checked, so a request that passes validation can still be rejected on creation.

To fetch the list of saved reports, use the method POST /custom-reports
The body can be empty ({}).

To fetch report data, use the method POST /custom-reports/data — the main method for building statistics.

Groupings (groups):

Metrics (metrics):

Example request:
​

Note: the report returns aggregated data only. Maximum granularity is hourly (time_hour). Raw per-user views/clicks by remoteUserId are only available via POST /stats/conversions (for conversions).

To fetch allowed values for a specific filter, use the method POST /custom-reports/filter-data

To fetch the full list of available groupings, metrics, and filters, use OPTIONS /custom-reports.

To fetch raw conversion data (one row per conversion), use the method POST /stats/conversions.
This is the only method that returns event-level data with remoteUserId. Note: the endpoint is /stats/conversions, NOT /stats/postback — do not confuse them.

Example request:
​

Response fields per conversion row:
​ conversionType, campaign (name + ID), campaignFolder, adId, conversionTime, auctionTime, conversionDelay, remoteUserId, audience, cpaCost, macrosId, clickId, url, status, callbackUri.

To fetch aggregated statistics per site (macrosID, PID), use the method POST /stats/sites.

Example request:
​

To update bids on multiple sites at once, use the method PUT /stats/sites/bids

The POST /stats/sites/block method stops buying the listed sites in the listed campaigns (adds them to the campaign blacklist). POST /stats/sites/unblock removes them from the blacklist. Blocking is per campaign: a site blocked in one campaign keeps running in the others. Repeated calls are safe.

Example request:

To fetch the list of financial operations, use the method POST /finances/operations

Example request:
​

The GET /finances/day-money-limit method returns the daily spending limit of the account, its minimum allowed value and currency. The PUT /finances/day-money-limit method sets the limit: limit — limit in the account currency, number; required parameter. 0 removes the limit. Raising or removing the limit reactivates campaigns that it has stopped.

Example request:

The GET /finances/payment-systems method returns the payment systems available for depositing to this account, with the commission, minimum and maximum amount for each currency. Until the first deposit, the minimum first-deposit amount is returned. The list depends on the account, so different advertisers may receive different responses.

Example request:

Sorting is specified as an object {"field": "asc"|"desc"}. Allowed fields are listed per method. Example:
​

By multiple fields:

In POST /custom-reports/data filters are described as an array of objects in filters.filters:

On error the response contains "success": false and a description in msg:

{ } "success": false, "code": 400, "msg": { "field": ["Error description"] }