Zasób zwraca dane dla modułów licznika spraw wychodzących i przychodzących dla dashboardu. Dane dostępne są dla każdej roli, od Praktykanta do Eksperta.

Endpointy obsługujące żądanie:

• https://api.5ways.com

Pobranie danych

GET /rest/dashboard_issue_stats

Zwróci obiekt statystyk. Jeśli zostanie wywołany bez parametrów, zostaną zwrócone statystyki spraw przychodzących, podzielonych na godziny w przedziale od początku godziny wywołania żądania do końca aktualnego dnia.

Odpowiedź

// HTTP/1.1 200 OK
{
    "results": [
        {
            "DashboardIssueStats": [
                {
                  "day_of_week": "4",
                  "day_of_week_name": "Thursday",
                  "issues": "3",
                  "type": "incoming"
                }
            ]
        }
    ]
}

day_of_week numer dnia tygodnia, liczony od poniedziałku, issues ilość spraw danego dnia,type typu przychodzącego

Dostępne parametry

Zasób możemy parametryzować:

type określa typ oczekiwanych statystyk:

• incoming dla spraw przychodzących,
• outcoming dla spraw wychodzących, czyli wysłanych odpowiedzi

aggregation określa rodzaj agregacji danych, sprawy zostaną podzielone na:

• hourly godziny określonego dnia,
• daily dni określonego miesiąca,
• daily_weekly dni okresu tygodnia od wyznaczonego dnia

date_from określa początkowy przedział czasu, wymagany jest format datetime zgodny z mysql YYYY-MM-DD hh:mm:ss. date_from będzie traktowane różnie w zależności od parametru aggregation:

• w hourly zostanie użyta wskazana data, ale minuty i sekundy zostaną ustawione na 00:00 (by brać pod uwagę pełną godzinę)
• w daily zostanie użyta wskazana data, ale dzień miesiąca zostanie ustawiony na pierwszy
• w daily_weekly zostanie użyta wskazana data, ale początek tygodnia zostanie ustawiony na najbliższy miniony poniedziałek godziny 00:00:00 do niedzieli 23:59:59

date_to data, z której zostanie użyty koniec okresu, używana tylko w aggregation=hourly do pobrania godziny. Pozostałe składowe daty są ignorowane. Przedział zawsze zaczyna się od wskazanej godziny, 00 minut, 00 sekund (w date_from) do końcowej godziny (w date_to) minus jeden, 59 minut 59 sekund. Wybierając godzinę 14:00:00, dostaniesz sprawy do godziny 13:59:59.

Agregacja nie uwzględnia godzin lub dni, w których nie ma spraw.

Przykładowe, sparametryzowane żądanie

GET /rest/dashboard_issue_stats?type=incoming&aggregation=hourly&date_from=2024-02-21%2007:00:00

Otrzymasz statystykę spraw przychodzących, podzieloną na poszczególne godziny dnia 21 lutego od godziny 7:00:00 do 23:59:59 tego samego dnia.