Средние показатели

Аккумулированные показатели коммуникаций

POST https://api.deeray.com/v1/carrot/analytics/conversation_brief

Path Parameters

Name	Type	Description
range.to	string	Вернуть данные по указанную дату
range.from	string	Вернуть данные с указанной даты
range	object	Диапазон дат, за который необходимо вернуть данные.
secret-key	string	Ключ доступа к проекту
api-key	string	Ключ авторизации клиента

200

{
	"items": [
		{
			"color": {
				"diff": "#1bc976",
				"value": "#673aef"
			},
			"diff": -12,
			"name": "Сообщений в коммуникации",
			"value": 43
		},
		{
			"color": {
				"diff": "#1bc976",
				"value": "#3cb9f1"
			},
			"diff": 132,
			"name": "Всего клиентов",
			"value": 25862
		}
	],
	"code": 0
}

Если атрибут range не указан, то данные будут предоставлены за последние 30 дней.

range.from и range.to должен быть в формате YYYY-MM-DD, например "2021-01-30".

В качестве ответа на запрос возвращаются блоки с данными по следующим показателям:

· продолжительность средней коммуникации (измеряется количеством сообщений внутри диалога);

· количество новых клиентов, с которыми происходила коммуникация.

Количество возвращаемых блоков может расширяться в зависимости от бизнес-процессов клиента. Например, вы можете расширить наполнение возвращаемых блоков такими показателями, как:

· общая продолжительность разговоров в разрезе операторов,

· средняя продолжительность разговора в разрезе оператора,

· количество исходящих звонков,

· количество входящих звонков и др.

Если вы хотите воспользоваться возможностью расширения количества возвращаемых «Средних показателей» - напишите нам [email protected] и мы сделаем все возможное, чтобы вы получили необходимые вам данные.

Детализация показателей коммуникаций

POST /v1/carrot/analytics/conversation

Path Parameters

Name	Type	Description
sample	string	Тип семплирования данных для отображении на графике. Может принимать значение: hours, days или weeks
range.to	string	Вернуть данные по указанную дату
range.from	string	Вернуть данные с указанной даты
range	object	Диапазон дат, за которые необходимо вернуть данные
secret-key	string	Ключ доступа к проекту
api-key	string	Ключ авторизации клиента

200

{
	"item": {
		"diagram": [
			{
				"name": "conversations",
				"values": [
					{ "0:00": 189 }, 
					{ "1:00": 244 }
				]
			}, {
				"name": "messages",
				"values": [
					{ "0:00": 110 }, 
					{ "1:00": 132 }
				]
			}, {
				"name": "new_clients",
				"values": [
					{ "0:00": 110 }, 
					{ "1:00": 132 }
				]
			}
		],
		"metric": {
			"conversations": {
				"average": 750,
				"maximum": {
					"description": 1283,
					"value": "8:00"
				}
			},
			"messages": {
				"average": 461,
				"maximum": {
					"description": 861,
					"value": "8:00"
				}
			},
			"new_clients": {
				"average": 460,
				"maximum": {
					"description": 857,
					"value": "8:00"
				}
			}
		}
	},
	"code": 0
}