Getting weights for advertising campaign parameters
| Method | get.campaign_parameter_weights |
|---|---|
| Description | Obtaining weights of advertising campaign parameters. A weighting system is needed to determine which advertising campaign to match with a visit. If, when you go to a site, one visit corresponds to several advertising campaigns, the system will assign an advertising campaign containing the condition whose value on the weight scale is the highest. |
| Available to | Agent, Client |
Request parameters
| Title | Type | Required | Description |
|---|---|---|---|
access_token |
string | yes | Authentication session key |
user_id |
number | no | Unique user identifier of the agent client on behalf of which the request is made Is required for the agentTo obtain a list of client users, you must use the "get.customer_user" method |
limit |
number | no | Number of records returned. See section "Paging" |
offset |
number | no | Shift determines from which record number to return "limit" records. Default is "0". See section "Paging" |
filter |
object | no | See section "Filtering criteria" |
fields |
array | no | See section "View of returned data" |
sort |
array | no | See section "Sorting data" |
Response parameters
| Name | Type | Valid values | Filtering | Sorting | Description |
|---|---|---|---|---|---|
site_id |
number | yes | yes | Unique site identifier | |
site_domain_name |
string | yes | Site address on the Internet. Without specifying the protocol - "http://" or "https://" | ||
entrance_page |
number | from 0 to 100 | The default value is "10". Login page | ||
referrer_domain |
number | from 0 to 100 | The default value is "20". Referrer domain | ||
search_engine |
number | from 0 to 100 | The default value is "20". Search engine | ||
search_query |
number | from 0 to 100 | The default value is "40". Search query | ||
engine |
number | from 0 to 100 | The default value is "25". Advertising system | ||
referrer |
number | from 0 to 100 | The default value is "30". Referrer | ||
channel |
number | from 0 to 100 | The default value is "15". Channel | ||
location |
number | from 0 to 100 | The default value is "5". Weight value for the parameters city, region, country | ||
utm_tags |
number | from 0 to 100 | The default value is "60". Weight value for parameters utm_source, utm_medium, utm_campaign, utm_term, utm_content | ||
os_tags |
number | from 0 to 100 | The default value is "50". Weight value for parameters openstat_service, openstat_campaign, openstat_source, openstat_ad | ||
other_tags |
number | from 0 to 100 | The default value is "60". Weight value for parameters ef_id, yclid, gclid, ymclid |
JSON request structure```json
{ "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 response structure```json
{
"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 returned errors
See the section "List of errors for methods with the verb get"