Retrieves the relative weights used to select a campaign when a visit matches multiple campaigns. The campaign with the highest-weighted matching condition is selected.

Retrieves the relative weights used to select a campaign when a visit matches multiple campaigns. The campaign with the highest-weighted matching condition is selected

Method	get.campaign_parameter_weights
Description	Retrieves the relative weights used to select a campaign when a visit matches multiple campaigns. The campaign with the highest-weighted matching condition is selected.
Who has access	Agents and clients

Request parameters

Name	Type	Required	Description
access_token	string	yes	Session key used to authenticate the request
user_id	number	no	Unique ID of the client user on whose behalf the request is made. Required when an agent makes the request. To retrieve a list of client users, call "get.customer_users".
limit	number	no	Maximum number of records to return. See the "Paging" section.
offset	number	no	Number of records to skip before returning results. Default: 0. See the "Paging" section.
filter	object	no	Filtering criteria. See the "Filters" section.
fields	array	no	Fields to include in the response. See the "Viewing returned data" section.
sort	array	no	Sorting criteria. See the "Data sorting" section.

Response parameters

Name	Type	Valid values	Filtering	Sorting	Description
site_id	number		yes	yes	Unique site ID
site_domain_name	string		yes		Site domain name, without the protocol (http:// or https://)
entrance_page	number	0-100			Weight assigned to landing page matches. Default: 10
referrer_domain	number	0-100			Weight assigned to referrer domain matches. Default: 20
search_engine	number	0-100			Weight assigned to search engine matches. Default: 20
search_query	number	0-100			Weight assigned to search query matches. Default: 40
engine	number	0-100			Weight assigned to advertising platform matches. Default: 25
referrer	number	0-100			Weight assigned to referrer matches. Default: 30
channel	number	0-100			Weight assigned to channel matches. Default: 15
location	number	0-100			Weight assigned to city, region, and country matches. Default: 5
utm_tags	number	0-100			Weight assigned to utm_source, utm_medium, utm_campaign, utm_term, and utm_content matches. Default: 60
os_tags	number	0-100			Weight assigned to openstat_service, openstat_campaign, openstat_source, and openstat_ad matches. Default: 50
other_tags	number	0-100			Weight assigned to ef_id, yclid, gclid, and ymclid matches. Default: 60

Example request

{
    "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"
        ]
    }
}

Example response

{
    "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 "List of errors for get methods" section.