Skip to content

Update campaign parameter weights

Updating advertising campaign parameter weights

Method update.campaign_parameter_weights
Description Updating advertising campaign parameter weights. The system defines which campaign should be linked to a visit. If a visit is linked to several campaigns, the system will choose a campaign with the highest value as according to the weights scale.
Who has access Agent, Customer

Parameters of a request

Unique user ID of a customer or an agent that makes a request.
Is mandatory for agent
To get a list of a customer's users you need to use the method "get.customer_users"
Title Type Required Valid value Description
access_token string yes Authentication session key
user_id number no
site_id number yes Unique website ID
entrance_page number no from 0 to 100 Entrance page
referrer_domain number no from 0 to 100 Referrer domain
search_engine number no from 0 to 100 Search engine
search_query number no from 0 to 100 Search query
engine number no from 0 to 100 Advertising engine
referrer number no from 0 to 100 Referrer
channel number no from 0 to 100 Channel
location number no from 0 to 100 Value for weight of the following parameters: city, region, country
utm_tags number no from 0 to 100 Value for weight of the following parameters: utm_source, utm_medium, utm_campaign, utm_term, utm_content
os_tags number no from 0 to 100 Value for weight of the following parameters: openstat_service, openstat_campaign, openstat_source, openstat_ad
other_tags number no from 0 to 100 Value for weight of the following parameters: ef_id, yclid, gclid, ymclid

JSON request structure

{
  "jsonrpc": "2.0",
  "id": "number",
  "method": "update.campaign_parameter_weights",
  "params": {
    "access_token": "string",
    "user_id": "number",
    "site_id": "number",
    "other_tags": "number",
    "search_query": "number",
    "ad_engine": "number",
    "referrer": "number",
    "channel": "number",
    "entrance_page": "number",
    "location": "number",
    "utm_tags": "number",
    "os_tags": "number",
    "referrer_domain": "number",
    "search_engine": "number"
  }
}

JSON reply structure

{
  "jsonrpc": "2.0",
  "id": "number",
  "result": {
    "data": {

    },
    "metadata": {

    }
  }
}

List of returning errors

Refer to section "List of errors common for methods with the verb update"