Informacje

Uwierzytelnianie wymagane
Format odpowiedzi json
Metoda HTTP GET

GET chats/reports/summary

Ostatnia modyfikacja 2024-11-20 13:20:36

Zwraca raport czatów.

URL

https://your-system-name.thulium.com/api/chats/reports/summary

Parametry

limit

opcjonalny

Liczba rekordów, które mają być zwrócone. Domyślnie: 100. Maksymalna wartość: 100. Przykładowa wartość: 100
offset

opcjonalny

Od którego rekordu należy zwrócić rezultat (używane, gdy rekordów jest więcej, niż limit). Domyślna wartość: 0. Przykładowa wartość: 10
user_logins

opcjonalny

Lista loginów użytkowników dla której ma być wygenerowany raport. Przykładowa wartość: user_logins[]=jankowalski&user_logins[]=anowak
date_from

wymagany

Data rozpoczęcia. Przykładowa wartość: 2019-11-01 11:12:00
date_to

wymagany

Data zakończenia. Przykładowa wartość: 2019-11-02 11:12:00
sum_users

opcjonalny

Sumuj użytkowników, domyślnie false. Przykładowa wartość: true
aggregate_by

opcjonalny

Grupowanie, domyślenie miesiąc (month). Jedna z wartości: hour_of_day, minute, hour, day, week, month, year Przykładowa wartość: month
chat_queue_ids

opcjonalny

Lista identyfikatorów kolejek czatu. Przykładowa wartość: chat_queue_ids[]=1&chat_queue_ids[]=3
response_threshold

opcjonalny

Próg dla pierwszej odpowiedzi (s), domyślnie 20 Przykładowa wartość: 50

Przykładowy request

GET https://your-system-name.thulium.com/api/chats/reports/summary?user_logins[]=jkowalski&date_from=2024-10-22&date_to=2024-11-21&aggregate_by=day

Przykładowy response

[
  {
    "series": "2021-12",
    "user_name": "John Doe",
    "incoming": 1,
    "incoming_to_agent": 1,
    "incoming_including_empty": 1,
    "abandoned": 0,
    "answered": 1,
    "incoming_to_bot": 0,
    "transferred_by_bot": 0,
    "finished_by_bot": 0,
    "service_level_percent": 100,
    "chat_time": {
      "min": "00:00:48",
      "max": "00:00:48",
      "sum": "00:00:48",
      "avg": "00:00:48"
    },
    "wait_time": {
      "min": "00:00:00",
      "max": "00:00:00",
      "sum": "00:00:00",
      "avg": "00:00:00"
    },
    "sla_percent": 100,
    "rating": {
      "rate": {
        "sad": 0,
        "neutral": 0,
        "happy": 0
      },
      "satisfaction_percent": 0,
      "rated_percent": 0
    }
  }]

Przykładowe wywołanie


PHP 

<?php
$request = curl_init('https://your-system-name.thulium.com/api/chats/reports/summary?user_logins[]=jkowalski&date_from=2024-10-22&date_to=2024-11-21&aggregate_by=day');
curl_setopt($request, CURLOPT_HTTPHEADER, array('Content-Type: application/json; charset=utf-8'));
curl_setopt($request, CURLOPT_USERPWD, "api_user:api_pass");
curl_setopt($request, CURLOPT_TIMEOUT, 30);
curl_setopt($request, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($request);
if ($response) {
    $httpCode = curl_getinfo($request, CURLINFO_HTTP_CODE);
    if ($httpCode == 200){
        print_r(json_decode($response));
    } else {
        echo $response;
    }
} else {
    trigger_error(curl_error($request), E_USER_WARNING);
}

curl_close($request);
JAVA 

public class Example {
    public static void main(String[] args) throws Exception {
        ThuliumRestClient restClient = new ThuliumRestClient("api_user", "api_pass", true);

        ThuliumRestClient.ThuliumRestResponse response = restClient.get("https://your-system-name.thulium.com/api/chats/reports/summary?user_logins[]=jkowalski&date_from=2024-10-22&date_to=2024-11-21&aggregate_by=day");
        System.out.println(response);
    }
}

CURL 

curl -u api_user:api_pass -k -X GET -H "Accept: application/json" "https://your-system-name.thulium.com/api/chats/reports/summary?user_logins[]=jkowalski&date_from=2024-10-22&date_to=2024-11-21&aggregate_by=day"

HTTPie 

http -a api_user:api_pass GET https://your-system-name.thulium.com/api/chats/reports/summary user_logins[]==jkowalski date_from==2024-10-22 date_to==2024-11-21 aggregate_by==day Accept:application/json