Unique user identifier of the agent client on behalf of which the request is made (Is required for the agent) To obtain a list of client users, you must use the method "get.customer_users"
limit
number
no
Number of records to return. See "Paging"
offset
number
no
Shift, determines from which record number to return "limit" records. Default is "0". See "Paging"
report_id
number
yes
User report unique identifier. To get a list of user reports, you must use the "get.reports_list"
date_from
iso8601
yes
YYYY-MM-DD hh:mm:ss
Start date and time of the reporting period. Maximum range: 31 days.
date_till
iso8601
yes
YYYY-MM-DD hh:mm:ss
End date and time of the reporting period.
is_realtime
boolean
yes
Whether the requested report is a report for the last 30 minutes. Realtime report flag.
fields
array
no
Comma-separated list of column IDs. Required to return data; if omitted or empty, the response is empty. To retrieve available columns, use getobj.columns_tree. Their order determines the order of fields in the response.
Filters used in the report
filters
array
yes
A filter expression may contain simple filters, a nested filter tree, or both. To retrieve supported filters and values, use get.report_filters.
field
string
Field of the entity to which filtering will be applied (the list is predefined for the method)
operator
enum
Filtering operator. A list of all operators can be obtained in the section "Filtering operators"
value
string
Value for the filtering operator. Optional field; if it is missing, it is considered empty.
Sorting used in the report
Response parameters
Name
Type
Valid values
Filtering
Sorting
Default response
Description
site_domain_name
string
yes
yes
yes
Internet site address. Without specifying the protocol - "http://" or "https://"
site_domain_naked
string
yes
yes
yes
The main domain of a website address on the Internet.
Advertising systems
pc
string
yes
yes
yes
Name of external advertising campaign
pc_ext_id
string
yes
yes
yes
External identifier of external advertising campaign
gr
string
yes
yes
yes
Ad group name
gr_ext_id
string
yes
yes
yes
External ad group ID
ad
string
yes
yes
yes
Ad title
ad_ext_ids
string
yes
yes
yes
External ad ID. May contain several external ad ids.
kw
string
yes
yes
yes
Keyword
kw_ext_id
string
yes
yes
yes
External keyword identifier.
Traffic sources
campaign_name
string
yes
yes
yes
Advertising campaign name
channel_new
string
yes
yes
yes
Channel(new). Source channel name
channel_code
string
yes
yes
yes
Channel mnemonic
source_new
string
yes
yes
yes
Source(new). Source group
source_name
string
yes
yes
yes
Source (detailed). Source name
channel
string
yes
yes
Channel.
source
string
yes
yes
Source.
referrer
string
yes
yes
Transition source
referrer_domain
string
yes
yes
Referrer domain
search_query
string
yes
yes
Search query
UTM tags
utm_source
string
yes
yes
UTM Source tag
utm_medium
string
yes
yes
UTM tag Medium
utm_term
string
yes
yes
UTM tag Term
utm_content
string
yes
yes
UTM tag Content
utm_campaign
string
yes
yes
Campaign UTM tag
utm_referrer
string
yes
yes
Referrer UTM tag
utm_expid
string
yes
yes
Expid UTM tag
Openstat Tags
openstat_ad
string
yes
yes
Ad ID
openstat_campaign
string
yes
yes
Advertising campaign ID
openstat_service
string
yes
yes
Identifier of the service providing the service
openstat_source
string
yes
yes
ID of the site, section, page, the corresponding advertisement was shown
Other URL tags
ef_id
string
yes
yes
Used to mark up links in the AdLense contextual advertising management system
yclid
string
yes
yes
Yandex Click Identifier
gclid
string
yes
yes
Gclid label
cm_id
string
yes
yes
cm_id is a set of ValueTrack. ValueTrack are URL parameters that can be added to landing page URLs to collect click source information.
ymclid
string
yes
yes
Label value ymclid
tag_from
string
yes
yes
From label
Geography
visitor_country
string
yes
yes
Visitor country
visitor_region
string
yes
yes
Visitor region
visitor_city
string
yes
yes
Visitor city
visitor_provider
string
yes
yes
Visitor's Internet provider
visitor_ip_address
string
yes
yes
Visitor IP address
Computer
visitor_browser_name
string
yes
yes
Visitor's browser
visitor_browser_version
string
yes
yes
Visitor's browser version
visitor_os_name
string
yes
yes
Name of the visitor's operating system
visitor_os_version
string
yes
yes
Visitor operating system version
visitor_language
string
yes
yes
Localization of the visitor's device
visitor_screen
string
yes
yes
Visitor monitor resolution
visitor_device
object
yes
yes
Visitor device
value
string
Name of values
value_id
string
Unique value identifier
Visitor history
visitor_session_id
string
yes
yes
Unique visitor session identifier
visit_depth
number
yes
yes
View depth. Number of pages that were viewed per visit
entrance_page
string
yes
yes
Login page
visitor_type
object
yes
yes
Visitor type
value
string
Name of values
value_id
string
Unique value identifier
visitor_id
number
yes
yes
yes
Unique visitor identifier
person_id
number
yes
yes
yes
Unique person identifier
ua_client_id
string
yes
yes
Unique identifier in Universal Analytics
ym_client_id
string
yes
yes
Unique Yandex.Metrica user identifier
List of segments
segments
array
yes
Segments
segment_name
string
yes
Segment name
Visiting time
visit_date_time
iso8601
YYYY-MM-DD hh:mm:ss
yes
yes
yes
Date and time of visit
visit_date
iso8601
YYYY-MM-DD
yes
yes
Date of visit
visit_hour
object
yes
yes
Visiting hour
value
string
Name of values
value_id
string
Unique value identifier
visit_weekday
object
yes
yes
Day of week of visit
value
string
Name of values
value_id
string
Unique value identifier
visit_month
object
yes
yes
Month of visit
value
string
Name of values
value_id
string
Unique value identifier
visit_year
string
yes
yes
Year of visit
communications
array
no
no
no
Related requests
id
number
Unique communication ID.
type
object
Communication type.
value
string
Name of values
value_id
string
Unique value identifier
date_time
number
Request date
number_pool_name
string
no
no
no
Name of the call tracking rule that included the visit