Skip to content

Get campaign parameter weights

Getting advertising campaign parameter weights

Method get.campaign_parameter_weights
Description Getting advertising campaign parameter weights. System of weights is needed to specify 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

Title Type Required Description
access_token string yes Authentication session key
user_id number no Unique user ID of a customer or an agent who makes request.
Is required for an agent.
To a get a list of customer users you need to use the method "get.customer_user"
limit number no Number of returning entries. Refer to "Pagination"
offset number no Offset, that defines: entries from which number to return, "limit" of entries. Default value is "0". Refer to "Page-oriented output"
filter object no Refer to "Filtering criteria"
fields array no Refer to "Providing returning data"
sort array no Refer to "Data sorting"

Parameters of a reply

Title Type Valid value Filtering Sorting Description
site_id number yes yes Unique website ID
site_domain_name string yes Website address without protocol - "http://" or "https://"
entrance_page number from 0 to 100 Default value is "10". Entrance page
referrer_domain number from 0 to 100 Default value is "20". Referrer domain
search_engine number from 0 to 100 Default value is "20". Search engine
search_query number from 0 to 100 Default value is "40". Search query
engine number from 0 to 100 Default value is "25". Advertising engine
referrer number from 0 to 100 Default value is "30". Referrer
channel number from 0 to 100 Default value is "15". Channel
location number from 0 to 100 Default value is "5". Value for weight of the following parameters: city, region, country
utm_tags number from 0 ro 100 Default value is "60". Value for weight of the following parameters: utm_source, utm_medium, utm_campaign, utm_term, utm_content
os_tags number from 0 to 100 Default value is "50". Value for weight of the following parameters: openstat_service, openstat_campaign, openstat_source, openstat_ad
other_tags number from 0 to 100 Default value is "60". Value for weight of the following parameters: ef_id, yclid, gclid, ymclid

JSON request structure

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.campaign_parameter_weights",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "offset":"number",
    "limit":"number",
    "filter":{

    },
    "sort":[
      {
        "field":"string",
        "order":"string"
      }
    ],
    "fields":[
      "string"
    ]
  }
}

JSON reply structure

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

    },
    "data": [
      {
        "site_id": "number",
        "site_domain_name": "string",
        "entrance_page": "number",
        "referrer_domain": "number",
        "search_engine": "number",
        "search_query": "number",
        "engine": "number",
        "referrer": "number",
        "channel": "number",
        "location": "number",
        "utm_tags": "number",
        "os_tags": "number",
        "other_tags": "number"
      }
    ]
  }
}

List of returning errors

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