Retrieves all communications.

Retrieves all communications

Method	get.communications_report
Description	Retrieves all communications.
Who has access	Partners and clients

Request parameters

Name	Type	Required	Valid values	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 agent) To obtain a list of client users, you must use the method ""get.customer_users""
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"
sort	array	no		See section "Sorting data"
date_from	iso8601	yes	YYYY-MM-DD hh:mm:ss	Start date and time of the reporting period.
date_till	iso8601	yes	YYYY-MM-DD hh:mm:ss	End date and time of the reporting period.

Response parameters

Name	Type	Valid values	Filtering	Sorting	Default response	Description
id	number		yes		yes	Unique communication ID. Use the relevant report method to retrieve details: get.chats_report, get.goals_report, get.offline_messages_report, or get.calls_report.
communication_type	enum	chat, call, goal, offline_message	yes	yes	yes	Communication type. Use the relevant report method to retrieve details: get.chats_report, get.goals_report, get.offline_messages_report, or get.calls_report.
communication_number	number		yes	yes		Case number. Calculated within persons.
communication_page_url	string		no	no	no	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.
date_time	iso8601	YYYY-MM-DD hh:mm:ss	yes	yes	yes	Date and time of request
ua_client_id	string					Unique ID in Universal Analytics
ym_client_id	string					Unique Yandex.Metrica user identifier
sale_date	iso8601	YYYY-MM-DD hh:mm:ss	yes	yes		Trade date
sale_cost	number		yes	yes		Transaction amount
search_query	string		yes			Search query
search_engine	string		yes			Search engine name systems
referrer_domain	string		yes			Referrer domain
referrer	string		yes			Transition source
entrance_page	string		yes			Login page
gclid	string		yes			Google Click Identifier
yclid	string		yes			Yandex Click Identifier
ymclid	string					Yandex Market Click Identifier
ef_id	string		yes			Used for link markup in control system contextual advertising AdLense
channel	enum	display paid affiliate messenger social email organic internal recommendation cashed referral direct	yes			Channel.
Added tags
tags	array		yes			Tags, see method "get.tags"
tag_id	number					Unique tag ID
tag_name	string					Tag name
tag_type	enum	auto, manual				Tag type
tag_change_time	iso8601	YYYY-MM-DD hh:mm:ss				Date and time of registration tag
tag_user_id	number					Unique ID user who added tag
tag_user_login	string					User login, who added the tag
tag_employee_id	number					Unique ID employee who added tag
tag_employee_full_name	string					Full name of the employee who added the tag.
Visitor information
visitor_id	number		yes	yes	yes	Unique ID visitor
person_id	number		yes		yes	Unique person ID
visitor_type	enum	new, returning, unknown	yes	yes		Visitor type
visitor_session_id	number		yes		yes	Unique visitor session ID. See get.visitor_sessions_report.
visits_count	number		yes			Number of visits
visitor_first_campaign_id	number		yes			Unique ID of the visitor's first advertising campaign.
visitor_first_campaign_name	string		yes			Name of the first advertising campaign
visitor_city	string		yes			Visitor city
visitor_region	string		yes			Visitor region
visitor_country	string		yes			Visitor country
visitor_device	enum	desktop mobile tablet other	yes	yes		Visitor device
Visitor properties
visitor_custom_properties	array		yes			Visitor properties, which may be asked via personal office or using the JavaScript API [method Comagic.setProperty(name, value);]
property_name	string					The name of the property that must be assigned visitor
property_value	string					Property value
Website
site_id	number		yes	yes	yes	Unique site ID
site_domain_name	string		yes			Internet site address. Without specifying the protocol - "http://" or "https://"
Advertising campaign
campaign_id	number		yes	yes	yes	Unique advertising ID campaigns
campaign_name	string		yes			Advertising name campaigns
visit_other_campaign	boolean	true, false	yes			The flag shows that you have entered whether the visitor (within person) according to others advertising campaigns
Segments
segments	array		yes			Segments
segment_name	string					Segment name
segment_id	number					Unique segment identifier
UTM tags
utm_source	string		yes			Campaign source
utm_medium	string		yes			Campaign Channel
utm_term	string		yes			Keyword campaigns
utm_content	string		yes			Campaign content
utm_campaign	string		yes			Campaign name
utm_referrer	string		yes			Source of transition to the site
utm_expid	string		yes			Google Analytics Experiment ID
OS tags
openstat_ad	string		yes			Identifier advertisement
openstat_campaign	string		yes			Advertising ID campaigns
openstat_service	string		yes			Service ID, service provider
openstat_source	string		yes			Site ID, section, page, place on the page where was shown appropriate advertisement
Hit attributes
attributes	array	first - First quality through - End-to-end first quality primary - Primary secondary - Secondary lost - Lost target - Target off-target - Not targeted quality - Quality rest - target repeated requests (requests made during the period of repeated requests configured for the site in the CallGear account).	yes			Hit attribute
Extended UTM tags
eq_utm_source	string		yes			Extended utm_source
eq_utm_medium	string		yes			Extended utm_medium
eq_utm_term	string		yes			Extended utm_term
eq_utm_content	string		yes			Extended utm_content
eq_utm_campaign	string		yes			Extended utm_campaign
eq_utm_referrer	string		yes			Extended utm_referrer
eq_utm_expid	string		yes			Extended utm_expid
Source information
source_id	number		yes	yes		Source ID (detailed).
source_name	string		yes	yes		Source (detailed). Source name
source_new	string		yes	yes		Source(new). Source group
channel_new	string		yes	yes		Channel(new). Source channel name
channel_code	string		yes	yes		Channel mnemonic

Example request

{
"jsonrpc":"2.0",
"id":"number",
"method":"get.communications_report",
"params":{
"access_token":"string",
"user_id":"number",
"offset":"number",
"limit":"number",
"date_from":"iso8601",
"date_till":"iso8601",
"filter":{
},
"sort":[
{
"field":"string",
"order":"string"
}
],
"fields":[
"string"
]

}
}

Example response

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

},
"data":[
{
"id":"number",
"communication_type":"enum",
"communication_number":"number",
"communication_page_url": "string",
"date_time":"iso8601",
"ua_client_id":"string",
"ym_client_id": "string",
"sale_date":"iso8601",
"sale_cost":"number",
"search_query":"string",
"search_engine":"string",
"referrer_domain":"string",
"referrer":"string",
"entrance_page":"string",
"gclid":"string",
"yclid":"string",
"ymclid":"string",
"ef_id":"string",
"channel":"enum",
"tags":[
{
"tag_id":"number",
"tag_name":"string",
"tag_type":"enum",
"tag_change_time":"iso8601",
"tag_user_id":"number",
"tag_user_login":"string",
"tag_employee_id":"number",
"tag_employee_full":"string"
}
],
"site_id":"number",
"site_domain_name":"string",
"campaign_id":"number",
"campaign_name":"string",
"visit_other_campaign":"boolean",
"visitor_id":"number",
"person_id":"number",
"visitor_type":"enum",
"visitor_session_id":"number",
"visits_count":"number",
"visitor_first_campaign_id":"number",
"visitor_first_campaign_name":"string",
"visitor_city":"string",
"visitor_region":"string",
"visitor_country":"string",
"visitor_device":"enum",
"visitor_custom_properties":[
{
"property_name":"string",
"property_value":"string"
}
],
"segments":[
{
"segment_id":"number",
"segment_name":"string"
}
],
"utm_source":"string",
"utm_medium":"string",
"utm_term":"string",
"utm_content":"string",
"utm_campaign":"string",
"openstat_ad":"string",
"openstat_campaign":"string",
"openstat_service":"string",
"openstat_source":"string",
"eq_utm_source": "string",
"eq_utm_medium": "string",
"eq_utm_term": "string",
"eq_utm_content": "string",
"eq_utm_campaign": "string",
"eq_utm_referrer": "string",
"eq_utm_expid": "string",
"attributes":[

],
"source_id": "number",
"source_name": "string",
"source_new": "string",
"channel_new": "string",
"channel_code": "string"
}
]
}
}

Possible errors

See the "Errors for get methods" section.