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"
report_type
enum
yes
User report type. 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: 366 days.
date_till
iso8601
yes
YYYY-MM-DD hh:mm:ss
End date and time of the reporting period.
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.
Report filters
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.
Report sorting
Response parameters
Note: Not all response fields may be available. To retrieve the complete, current list of supported fields, use the column IDs returned by getobj.columns_tree.
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.
site_name
string
yes
yes
yes
Site name.
Communications
communication_type
object
yes
yes
yes
Communication type.
value
string
Name of values
value_id
string
Unique value identifier
communication_id
string
yes
yes
yes
Unique request ID.
communication_date_time
iso8601
YYYY-MM-DD hh:mm:ss
yes
yes
yes
Date and time of request
communication_kinds
array
yes
Type of request
communication_page_url
string
yes
yes
The URL of the page the visitor was on at the time of the call or the page of the visitor's last interaction before the call.
is_communication_with_visit
object
yes
yes
Indicates whether the communication is linked to a visitor session.
value
string
Name of values
value_id
string
Unique value identifier
communication_number
number
yes
yes
yes
Case number. Calculated per person.
contact_phone_number
string
yes
yes
yes
For inbound calls, the contact number that placed the call. For outbound calls, the contact number that was called.
virtual_phone_number
string
yes
yes
yes
Virtual number
contact_full_name
string
yes
yes
yes
Last name First name Middle name of the contact or the name specified in the application.
total_duration
number
yes
yes
Call duration or chat duration, value in seconds
Added tags
tags
object
yes
yes
Tags
communication_id
number
Unique request ID.
communication_type
string
Communication type.
items
array
List of tags with parameters
id
number
Unique tag identifier
name
string
Tag name
Employees who participated in the call, chat or request
employees
array
yes
Employees who participated in the call
employee_full_name
string
Employee full name.
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
Advertising campaign parameters
eq_utm_source
string
yes
yes
Extended UTM Source tag
eq_utm_medium
string
yes
yes
Extended UTM tag Medium
eq_utm_term
string
yes
yes
Extended UTM tag Term
eq_utm_content
string
yes
yes
Extended UTM content tag
eq_utm_campaign
string
yes
yes
Campaign UTM tag
eq_utm_referrer
string
yes
yes
Extended UTM Referrer tag
eq_utm_expid
string
yes
yes
Extended UTM tag Expid
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
number
yes
yes
Unique visitor session identifier
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
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
Calls
call_type
object
yes
yes
yes
Call type
value
string
Name of values
value_id
string
Unique value identifier
call_status
object
yes
yes
yes
Indicates whether the call was missed.
value
string
Name of values
value_id
string
Unique value identifier
call_direction
object
yes
yes
yes
Call direction
value
string
Name of values
value_id
string
Unique value identifier
phone_tracking_type
object
yes
yes
Call tracking number type
value
string
Name of values
value_id
string
Unique value identifier
call_region_name
string
yes
yes
Caller's region.
call_records
array
yes
yes
Unique recording link ID.
Requests
offline_message_type
object
yes
yes
yes
Application type
value
string
Name of values
value_id
string
Unique value identifier
offline_message_email
string
yes
yes
yes
E-mail address left by the visitor in the application