Wywołania dotyczące danych statystycznych e-usług¶
Pobieranie listy dostępnych e-usług¶
-
GET
/api/v1/data/services
¶ Zwraca listę monitorowanych e-usług.
Przykładowe żądanie:
GET /api/v1/data/services HTTP/1.1
Przykładowa odpowiedź:
HTTP/1.1 200 OK Content-Type: application/json [ { "name": "SRP - Sprawdź czy twój dowód osobisty jest gotowy", "slug": "srp-do", "url": "https://widok.gov.pl/api/v1/data/services/srp-do/transactional-services" }, { "name": "SRP - Sprawdź swoje dane w Rejestrze PESEL", "slug": "srp-pesel", "url": "https://widok.gov.pl/api/v1/data/services/srp-pesel/transactional-services" } ]
Response Headers: - Content-Type –
application/json
Response JSON Array of Objects: - name (string) – Nazwa usługi
- slug (string) – Identyfikator usługi
service
- url (string) – Adres url do pobierania danych e-usługi
Status Codes: - 200 OK – brak błędu
- 400 Bad Request – błędne zapytanie
- 404 Not Found – serwis o takim identyfikatorze nie istnieje
- Content-Type –
Pobranie danych e-usług¶
-
GET
/api/v1/data/services/
(string: service)/transactional-services
¶ Zwraca dane statystyczne dla e-usługi.
Przykładowe żądanie:
GET /api/v1/data/services/punkty_karne/transactional-services?start_at=2017-05-01&end_at=2017-05-02&period=day HTTP/1.1
Przykładowa odpowiedź:
HTTP/1.1 200 OK Content-Type: application/json { "data": [ { "_start_at": "2017-05-01T00:00:00.000Z", "_end_at": "2017-05-01T23:59:59.000Z", "user_satisfaction_rate": 0.99, "completion_rate": 0.99, "digital_takeup": 1.0, "number_of_transactions": 123546, }, { "_start_at": "2017-05-02T00:00:00.000Z", "_end_at": "2017-05-02T23:59:59.000Z", "user_satisfaction_rate": 0.98, "completion_rate": 0.97, "digital_takeup": 0.9, "number_of_transactions": 23728, } ], "service_cost": 12000000.00, "service_transaction_cost": 0.54, "returned_rows": 2 }
Request Headers: - Content-Type –
application/json
Parameters: - service (string) – nazwa usługi
Query Parameters: - start_at (string) – początek analizowanego okresu czasu
- end_at (string) – koniec analizowanego okresu czasu
- period (string) –
okres, wg którego mają być grupowane dane:
- year - rocznie
- quarter - kwartalnie
- month - miesięcznie
- week - tygodniowo
- day - dziennie
Response Headers: - Content-Type –
application/json
Response JSON Object: - data (array) –
lista obiektów opisujących dane statystyczne
-
object
- _start_at (string) – data początku analizowanej jednostki okresu (np. dnia)
- _end_at (string) – data końca analizowanej jednostki okresu
- user_satisfaction_rate (float) – wskaźnik zadowolenia użytkownika
- completion_rate (float) – stopień ukończenia
- digital_takeup (float) – stopień przejęcia cyfrowego
- number_of_transactions (int) – liczba transakcji ogółem
-
- service_cost (float) – koszt całkowity systemu w podanym przedziale czasowym
- service_transaction_cost (float) – średni koszt transakcji w podanym przedziale czasowym
- returned_rows (integer) – ogólna liczba zwróconych rekordów
Status Codes: - 200 OK – brak błędu
- 400 Bad Request – błędne zapytanie
- 404 Not Found – serwis o takim identyfikatorze nie istnieje
- Content-Type –