Informacje

Uwierzytelnianie wymagane
Format odpowiedzi json
Metoda HTTP GET

GET agents_work_report

Ostatnia modyfikacja 2025-11-07 13:34:16

Zwraca raport pracy agentów.

URL

https://your-system-name.thulium.com/api/agents_work_report

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
agent_logins

opcjonalny

Lista loginów agentów dla której ma być wygenerowany raport. UWAGA: Jeśli parametr nie zostanie przekazany wymagane jest podanie parametru agent_group_ids.
Identyfikatory agentów możemy pobrać z /agents Przykładowa wartość: agent_logins[]=jankowalski&agent_logins[]=anowak
agent_group_ids

opcjonalny

Lista identyfikatorów grup agentów dla której ma być wygenerowany raport. UWAGA: Jeśli parametr nie zostanie przekazany wymagane jest podanie parametru agent_logins.
Lista identyfikatorów grup agentów może zostać pobrana z /agents_groups Przykładowa wartość: agent_group_ids[]=2&agent_group_ids[]=3&agent_group_ids[]=9
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
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
queues_ids

opcjonalny

Lista identyfikatorów kolejek. Przykładowa wartość: queues_ids[]=1&queues_ids[]=3
outbound_threshold

opcjonalny

Próg dla wychodzących (s), domyślnie 0 Przykładowa wartość: 10

Przykładowy request

GET https://your-system-name.thulium.com/api/agents_work_report?agent_logins[]=jkowalski&date_from=2025-10-17&date_to=2025-11-16&aggregate_by=day

Przykładowy response

[
    {
        "agent": {
            "login": jkowalski,
            "name": "Janko",
            "surname": "Walski"
        },
        "period": "2019-12",
        "inbound": {
            "count": 0,
            "answered_count": 0,
            "not_answered_count": 0,
            "transferred_count": 0,
            "sum": "00:00:00",
            "average": "00:00:00",
            "wait_sum": 0,
            "wait_average": "00:00:00",
            "calls_per_hour": 0
        },
        "chat": {
            "closed": 0,
            "responded": 0
        },
        "ticket": {
            "closed": 0,
            "responded": 0,
            "total_responded": 0
        },
        "outbound_above_threshold": {
            "count": 0,
            "sum": "00:00:00",
            "average": "00:00:00"
        },
        "outbound_below_threshold": {
            "count": 0,
            "sum": "00:00:00",
            "average": "00:00:00"
        },
        "login_date": "2019-12-01 09:00:18",
        "logout_date": "2019-12-25 10:45:02",
        "pauses": [
            {
                "id": "all",
                "count": 0,
                "sum": "00:00:00",
                "average": "00:00:00"
            },
            {
                "id": "free",
                "count": 0,
                "sum": "00:00:00",
                "average": "00:00:00"
            },
            {
                "id": 0,
                "count": 0,
                "sum": "00:00:00"
            },
            {
                "id": 1,
                "count": 0,
                "sum": "00:00:00",
                "average": "00:00:00"
            },
            {
                "id": 2,
                "count": 0,
                "sum": "00:00:00",
                "average": "00:00:00"
            },
            {
                "id": 3,
                "count": 0,
                "sum": "00:00:00"
            },
            {
                "id": 4,
                "count": 0,
                "sum": "00:00:00"
            }
        ]
    }
]

Przykładowe wywołanie


PHP 

<?php
$request = curl_init('https://your-system-name.thulium.com/api/agents_work_report?agent_logins[]=jkowalski&date_from=2025-10-17&date_to=2025-11-16&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/agents_work_report?agent_logins[]=jkowalski&date_from=2025-10-17&date_to=2025-11-16&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/agents_work_report?agent_logins[]=jkowalski&date_from=2025-10-17&date_to=2025-11-16&aggregate_by=day"

HTTPie 

http -a api_user:api_pass GET https://your-system-name.thulium.com/api/agents_work_report agent_logins[]==jkowalski date_from==2025-10-17 date_to==2025-11-16 aggregate_by==day Accept:application/json