Wywołania dotyczące danych statystycznych stron internetowych (web traffic dashboards)

Zapytanie o listę monitorowanych serwisów

GET /api/v1/data/websites

Zwraca listę monitorowanych serwisów.

Przykładowe żądanie:

GET /api/v1/data/websites HTTP/1.1

Przykładowa odpowiedź:

HTTP/1.1 200 OK
Content-Type: application/json


[
    {
        "name": "Ministerstwo Cyfryzacji",
        "slug": "ministerstwo-cyfryzacji",
        "traffic_count": "https://widok.gov.pl/api/v1/data/websites/ministerstwo-cyfryzacji/traffic-count",
        "browsers_count": "https://widok.gov.pl/api/v1/data/websites/ministerstwo-cyfryzacji/browsers-count",
        "devices_count": "https://widok.gov.pl/api/v1/data/websites/ministerstwo-cyfryzacji/devices-count",
        "os_count": "https://widok.gov.pl/api/v1/data/websites/ministerstwo-cyfryzacji/os-count",
        "keywords_count": "https://widok.gov.pl/api/v1/data/websites/ministerstwo-cyfryzacji/keywords-count",
        "country_count": "https://widok.gov.pl/api/v1/data/websites/ministerstwo-cyfryzacji/country-count",
        "popular_content_count": "https://widok.gov.pl/api/v1/data/websites/ministerstwo-cyfryzacji/popular-content-count"
    },
    {
        "name": "Ministerstwo Kultury i Dziedzictwa Narodowego",
        "slug": "mkidn",
        "traffic_count": "https://widok.gov.pl/api/v1/data/websites/mkidn/traffic-count",
        "browsers_count": "https://widok.gov.pl/api/v1/data/websites/mkidn/browsers-count",
        "devices_count": "https://widok.gov.pl/api/v1/data/websites/mkidn/devices-count",
        "os_count": "https://widok.gov.pl/api/v1/data/websites/mkidn/os-count",
        "keywords_count": "https://widok.gov.pl/api/v1/data/websites/mkidn/keywords-count",
        "country_count": "https://widok.gov.pl/api/v1/data/websites/mkidn/country-count",
        "popular_content_count": "https://widok.gov.pl/api/v1/data/websites/mkidn/popular-content-count"
    }
]
Response Headers:
 
Response JSON Array of Objects:
 
  • name (string) – Nazwa usługi
  • slug (string) – Identyfikator usługi website
  • traffic_count (string) – Adres url do pobierania ogólnej liczby odwiedzin
  • browsers_count (string) – Adres url do pobierania liczby użytkowników wg przeglądarek
  • devices_count (string) – Adres url do pobierania liczby użytkowników wg narzędzia
  • os_count (string) – Adres url do pobierania liczby użytkowników wg systemów operacyjnych
  • keywords_count (string) – Adres url do pobierania liczby popularnych słów kluczowych
  • country_count (string) – Adres url do pobierania liczby użytkowników wg kraju
  • popular_content_count (string) – Adres url do pobierania liczby popularnych podstron
Status Codes:

Odczyt danych - ogólna liczba odwiedzin

GET /api/v1/data/websites/(string: website)/traffic_count

Zwraca dane statystyczne dotyczące ogólnej liczby odsłon i sesji.

W zależności od parametru, wyróżniamy 4 typy zapytań:

  1. sumaryczna liczba odwiedzin wg. lat
  2. sumaryczna liczba odwiedzin wg. miesięcy dla wybranego roku
  3. sumaryczna liczba odwiedzin wg. dni dla wybranego miesiąca i roku
  4. sumaryczna liczba odwiedzin co do godziny dla wybranego dnia w roku

W zależności od wybranego typu istnieją parametry wymagane i różna jest struktura odpowiedzi.

Zapytanie o liczbę odwiedzin w ciągu roku

GET /api/v1/data/websites/(string: website)/traffic_count?type=year

Przykładowe żądanie:

GET /api/v1/data/websites/CEPIK-PK-WWW/traffic-count?type=year HTTP/1.1

Przykładowa odpowiedź:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "returned_rows": 3,
    "data": [
        {
            "year": 2015,
            "sessions": 103540,
            "users": 34561
        },
        {
            "year": 2016,
            "sessions": 60432,
            "users": 23456
        },
        {
            "year": 2017,
            "sessions": 31745,
            "users": 13595
        }
    ]
}
Request Headers:
 
Parameters:
  • website (string) – nazwa (identyfikator) strony instytucji, której dane są pobierane przez użytkownika
Query Parameters:
 
  • type (string) – typ pobierania danych - tutaj „year”
Response Headers:
 
Response JSON Object:
 
  • returned_rows (integer) – ogólna liczba zwróconych rekordów
  • data (array) –

    lista obiektów opisujących dane statystyczne

    object
    • year (integer) – rok
    • sessions (integer) – liczba sesji,
    • users (integer) – liczba użytkowników,
Status Codes:

Zapytanie o liczbę odwiedzin w ciągu miesiąca dla wybranego roku

GET /api/v1/data/websites/(string: website)/traffic_count?type=month

Przykładowe żądanie:

GET /api/v1/data/websites/CEPIK-PK-WWW/traffic-count?type=month&year=2017 HTTP/1.1

Przykładowa odpowiedź:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "data": [
        {
            "month": 1,
            "users": 4439,
            "sessions": 4334
        },
        {
            "month": 2,
            "users": 4153,
            "sessions": 4047
        },
        {
            "month": 3,
            "users": 5638,
            "sessions": 5505
        },
        {
            "month": 4,
            "users": 4883,
            "sessions": 4768
        },
        {
            "month": 5,
            "users": 6081,
            "sessions": 5960
        },
        {
            "month": 6,
            "users": 5322,
            "sessions": 5241
        },
        {
            "month": 7,
            "users": 1101,
            "sessions": 1842
        }
    ],
    "returned_rows": 7
}
Request Headers:
 
Parameters:
  • website (string) – nazwa (identyfikator) strony instytucji, której dane są pobierane przez użytkownika
Query Parameters:
 
  • type (string) – typ pobierania danych - tutaj „month”
  • year (string) – wybrany rok
Response Headers:
 
Response JSON Object:
 
  • data (array) –

    lista obiektów opisujących dane statystyczne

    object
    • month (integer) – miesiąc
    • sessions (integer) – liczba sesji,
    • users (integer) – liczba użytkowników,
  • returned_rows (integer) – ogólna liczba zwróconych rekordów
Status Codes:

Zapytanie o liczbę odwiedzin w ciągu dnia dla wybranego miesiąca

GET /api/v1/data/websites/(string: website)/traffic_count?type=day

Przykładowe żądanie:

GET /api/v1/data/websites/CEPIK-PK-WWW/traffic-count?type=day&year=2016&month=12 HTTP/1.1

Przykładowa odpowiedź:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "data": [
        {
            "date": "01-12-2016",
            "users": 456,
            "sessions": 45
        },
        {
            "date": "02-12-2016",
            "users": 456,
            "sessions": 45
        }
    ],
    "returned_rows": 2
}
Request Headers:
 
Parameters:
  • website (string) – nazwa (identyfikator) strony instytucji, której dane są pobierane przez użytkownika
Query Parameters:
 
  • type (string) – typ pobierania danych - tutaj „day”
  • year (string) – wybrany rok
  • month (string) – wybrany miesiąc
Response Headers:
 
Response JSON Object:
 
  • data (array) –

    lista obiektów opisujących dane statystyczne

    object
    • date (string) – data w formacie: dd-mm-yyyy
    • sessions (integer) – liczba sesji,
    • users (integer) – liczba użytkowników,
  • returned_rows (integer) – ogólna liczba zwróconych rekordów
Status Codes:

Zapytanie o liczbę odwiedzin w ciągu godziny dla wybranego dnia

GET /api/v1/data/websites/(string: website)/traffic_count?type=hour

Przykładowe żądanie:

GET /api/v1/data/websites/CEPIK-PK-WWW/traffic-count?type=hour&date=15-02-2016 HTTP/1.1

Przykładowa odpowiedź:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "data": [
        {
            "hour": 6,
            "users": 23,
            "sessions": 23
        },
        {
            "hour": 7,
            "users": 1,
            "sessions": 1
        },
    ],
    "returned_rows": 2
}
Request Headers:
 
Parameters:
  • website (string) – nazwa (identyfikator) strony instytucji, której dane są pobierane przez użytkownika
Query Parameters:
 
  • type (string) – typ pobierania danych - tutaj „hour”
  • date (string) – wybrany dzień w formacie „dd-mm-yyyy”
  • date – wybrany dzień w formacie „dd-mm-yyyy”
Response Headers:
 
Response JSON Object:
 
  • data (array) –

    lista obiektów opisujących dane statystyczne

    object
    • hour (string) – godzina dla wybranego dnia
    • sessions (integer) – liczba sesji,
    • users (integer) – liczba użytkowników,
  • returned_rows (integer) – ogólna liczba zwróconych rekordów
Status Codes:

Odczyt danych - liczba użytkowników wg urządzenia

GET /api/v1/data/websites/(string: website)/devices-count

Zwraca dane statystyczne grupując użytkowników wg używanych przeglądarek.

Przykładowe żądanie:

GET /api/v1/data/websites/CEPIK-PK-WWW/devices-count?period=year HTTP/1.1

Przykładowa odpowiedź:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "data": [
        {
            "users": 28999,
            "device": "desktop",
            "sessions": 28345
        },
        {
            "users": 2688,
            "device": "mobile",
            "sessions": 2661
        },
        {
            "users": 414,
            "device": "tablet",
            "sessions": 410
        }
    ],
    "returned_rows": 3
}
Request Headers:
 
Parameters:
  • website (string) – nazwa (identyfikator) strony instytucji, której dane są pobierane przez użytkownika
Query Parameters:
 
  • period (string) –

    okres, wg którego mają być grupowane dane:

    • year - ostatni rok
    • month - ostatni miesiąc
    • week - 7 dni
Response Headers:
 
Response JSON Object:
 
  • data (array) –

    lista obiektów opisujących dane statystyczne (max. 3 pozycje)

    object
    • device (string) – nazwa urządzenia (PC, tablet, mobile),
    • users (integer) – zsumowana liczba wizyt z danego typu urządzenia,
    • sessions (integer) – liczba sesji,
  • returned_rows (integer) – ogólna liczba zwróconych rekordów
Status Codes:

Odczyt danych - liczba użytkowników wg przeglądarek

GET /api/v1/data/websites/(string: website)/browsers-count

Zwraca dane statystyczne dotyczące liczby użytkowników pogrupowanych wg przeglądarek.

Przykładowe żądanie:

GET /api/v1/data/websites/CEPIK-PK-WWW/browsers-count?period=month HTTP/1.1

Przykładowa odpowiedź:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "data": [
        {
            "browser": "Firefox",
            "users": 14797,
            "sessions": 14329
        },
        {
            "browser": "Chrome",
            "users": 10900,
            "sessions": 10807
        },
    ],
    "returned_rows": 2
}
Request Headers:
 
Parameters:
  • website (string) – nazwa (identyfikator) strony instytucji, której dane są pobierane przez użytkownika
Query Parameters:
 
  • period (string) –

    okres, wg którego mają być grupowane dane:

    • year - ostatni rok
    • month - ostatni miesiąc
    • week - 7 dni
Response Headers:
 
Response JSON Object:
 
  • data (array) –

    lista obiektów opisujących dane statystyczne (max. 10 pozycji)

    object
    • device (string) – nazwa przeglądarki internetowej,
    • users (integer) – zsumowana liczba wizyt z danego typu urządzenia,
    • sessions (integer) – liczba sesji,
  • returned_rows (integer) – ogólna liczba zwróconych rekordów
Status Codes:

Odczyt danych - liczba użytkowników wg systemów operacyjnych

GET /api/v1/data/websites/(string: website)/os-count

Zwraca dane statystyczne dotyczące liczby użytkowników pogrupowanych wg systemów operacyjnych.

Przykładowe żądanie:

GET /api/v1/data/CEPIK-PK-WWW/os-count?period=week HTTP/1.1

Przykładowa odpowiedź:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "data": [
        {
            "os": "Windows",
            "users": 27213,
            "sessions": 26559
        },
        {
            "os": "Android",
            "users": 2187,
            "sessions": 2166
        },
    ],
    "returned_rows": 2
}
Request Headers:
 
Parameters:
  • website (string) – nazwa (identyfikator) strony instytucji, której dane są pobierane przez użytkownika
Query Parameters:
 
  • period (string) –

    okres, wg którego mają być grupowane dane:

    • year - ostatni rok
    • month - ostatni miesiąc
    • week - 7 dni
Response Headers:
 
Response JSON Object:
 
  • data (array) –

    lista obiektów opisujących dane statystyczne (max. 10 pozycji)

    object
    • device (string) – nazwa przeglądarki internetowej,
    • users (integer) – zsumowana liczba wizyt z danego typu urządzenia,
    • sessions (integer) – liczba sesji,
  • returned_rows (integer) – ogólna liczba zwróconych rekordów
Status Codes:

Odczyt danych - liczba użytkowników wg kraju

GET /api/v1/data/websites/(string: website)/country-count

Zwraca dane statystyczne dotyczące liczby użytkowników pogrupowanych wg kraju.

Przykładowe żądanie:

GET /api/v1/data/CEPIK-PK-WWW/country-count?period=year HTTP/1.1

Przykładowa odpowiedź:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "data": [
        {
            "code": "PL",
            "sessions": 77945,
            "country": "Poland",
            "users": 78845
        },
        {
            "code": "ES",
            "sessions": 77945,
            "country": "Spain",
            "users": 78845
        },
    ],
    "returned_rows": 2
}
Request Headers:
 
Parameters:
  • website (string) – nazwa (identyfikator) strony instytucji, której dane są pobierane przez użytkownika
Query Parameters:
 
  • period (string) –

    okres, wg którego mają być grupowane dane:

    • year - ostatni rok
    • month - ostatni miesiąc
    • week - 7 dni
Response Headers:
 
Response JSON Object:
 
  • data (array) –

    lista obiektów opisujących dane statystyczne

    object
    • code (string) – kod kraju w systemie ISO 3166-1 alfa 2 (duże 2 litery),
    • users (integer) – zsumowana liczba wizyt z danego typu urządzenia,
    • sessions (integer) – liczba sesji,
  • returned_rows (integer) – ogólna liczba zwróconych rekordów
Status Codes:

Odczyt danych - liczba popularnych słów kluczowych

GET /api/v1/data/websites/(string: website)/keywords-count

Zwraca dane statystyczne dotyczące liczby użytkowników pogrupowanych wg kraju.

Przykładowe żądanie:

GET /api/v1/data/CEPIK-PK-WWW/keywords-count?period=week HTTP/1.1

Przykładowa odpowiedź:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "data": [
        {
            "keyword": "CEPIK",
            "users": 44
        },
        {
            "keyword": "CEPIK-PK-WWW"
            "users": 30
        },
    ],
    "returned_rows": 2
}
Request Headers:
 
Parameters:
  • website (string) – nazwa (identyfikator) strony instytucji, której dane są pobierane przez użytkownika
Query Parameters:
 
  • period (string) –

    okres, wg którego mają być grupowane dane:

    • year - ostatni rok
    • month - ostatni miesiąc
    • week - 7 dni
Response Headers:
 
Response JSON Object:
 
  • data (array) –

    lista obiektów opisujących dane statystyczne (max. 30 pozycji)

    object
    • keyword (string) – słowo kluczowe
    • users (integer) – zsumowana liczba wizyt z danego typu urządzenia,
  • returned_rows (integer) – ogólna liczba zwróconych rekordów
Status Codes:

Odczyt danych - liczba popularnych podstron

Zwraca dane statystyczne dotyczące liczby użytkowników pogrupowanych wg kraju.

Przykładowe żądanie:

GET /api/v1/data/itl/popular-content-count?period=year HTTP/1.1

Przykładowa odpowiedź:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "data": [
        {
            "users": 45316,
            "title_page": "",
            "url": "http://www.itl.waw.pl/"
        },
        {
            "users": 3266,
            "title_page": "",
            "url": "http://www.itl.waw.pl/icton-2017-preliminary-programme"
        },
        {
            "users": 2839,
            "title_page": "",
            "url": "http://www.itl.waw.pl/o-instytucie/kierownictwo"
        },
    ],
    "returned_rows": 3
}
Request Headers:
 
Parameters:
  • website (string) – nazwa (identyfikator) strony instytucji, której dane są pobierane przez użytkownika
Query Parameters:
 
  • period (string) –

    okres, wg którego mają być grupowane dane:

    • year - ostatni rok
    • month - ostatni miesiąc
    • week - 7 dni
Response Headers:
 
Response JSON Object:
 
  • data (array) –

    lista obiektów opisujących dane statystyczne (max. 30 pozycji)

    object
    • title_page (string) – tytuł strony
    • url (string) – adres url do strony
    • users (integer) – zsumowana liczba wizyt z danego typu urządzenia,
  • returned_rows (integer) – ogólna liczba zwróconych rekordów
Status Codes: