REST API

Dane NowMetrix w narzędziach używanych już przez zespół.

Można rozpocząć od bieżącej migawki danych, zbudować ekran dla redakcji lub wysłać dane historyczne do procesu raportowania. Wystarczy wybrać endpoint i otworzyć jego pełną dokumentację techniczną.

Połączenie aplikacji

W przypadku pierwszego kontaktu z API warto rozpocząć od pełnego przewodnika połączenia. Wyjaśniono w nim, jak utworzyć i zabezpieczyć klucz API, zweryfikować go za pomocą /api/me oraz wykonać takie samo uwierzytelnione żądanie w popularnych językach programowania.

Przewodnik połączenia

Jeden bazowy adres URL

Każde żądanie uwierzytelnione za pomocą klucza API rozpoczyna się od tego hosta:

https://api.nowmetrix.com

Przesyłanie klucza API

Klucz API należy przesłać jako token Bearer w nagłówku Authorization. Administratorzy kont i członkowie zespołu z dostępem do API mogą tworzyć i oznaczać maksymalnie 10 aktywnych kluczy w panelu NowMetrix, w sekcji Ustawienia -> API.

Authorization: Bearer nm_YOUR_KEY

Wymagany jest protokół HTTPS. Wszystkie klucze korzystają z uprawnień przypisanych użytkownikowi NowMetrix i współdzielą limit żądań danego trackera.

Pierwsze żądanie

Najszybszym sposobem sprawdzenia konfiguracji jest pobranie bieżącej migawki danych. Pozwala to potwierdzić, że klucz działa i zapewnia dostęp do trackera.

curl -H "Authorization: Bearer nm_YOUR_KEY" \
  "https://api.nowmetrix.com/v1/realtime?site=TRACKER_ID"

Wybór potrzebnych danych

Metoda Ścieżka Opis Dokumentacja
GET /v1/realtime Bieżąca migawka danych na żywo: aktywni użytkownicy, odsłony, najpopularniejsze strony, urządzenia, kraje, miasta i źródła. Dokumentacja endpointu
GET /v1/sources Źródła ruchu z bieżącego okna danych na żywo wraz z klasyfikacją i opcjonalnymi wierszami podrzędnymi. Dokumentacja endpointu
GET /v1/overview Dzienne odsłony i wizyty z ostatnich N zakończonych wierszy danych historycznych. Dokumentacja endpointu
GET /v1/recap Dane Recap, podsumowanie wskaźników i najpopularniejsze strony dla gotowych zakresów lub niestandardowego zakresu dat. Dokumentacja endpointu
GET /v1/pulse Dane Pulse z dziś, porównanie z wczoraj i śródzienne wykresy w 15-minutowych przedziałach. Dokumentacja endpointu
GET /v1/proofreading Maksymalnie 100 obecnie widocznych sugestii korekty tekstu z ostatnio sprawdzonych artykułów jednego trackera. Dokumentacja endpointu
GET /v1/responsibilities Bieżące odpowiedzialności zespołu dla trackera, w tym osoby przypisane do każdej widocznej roli. Dokumentacja endpointu
GET /api/me Kontekst konta klucza API: bieżący tracker oraz wszystkie trackery, do których token zapewnia dostęp. Dokumentacja endpointu

Szybkie i przewidywalne żądania

Publiczne API umożliwia wykonanie 20 żądań na minutę dla każdego trackera. Wielu użytkowników lub wiele kluczy odpytujących ten sam tracker korzysta ze wspólnego licznika.

X-RateLimit-Limit: 20
X-RateLimit-Remaining: 7
X-RateLimit-Reset: 1783612801
Retry-After: 42
W miarę możliwości warto buforować odpowiedzi API we własnym systemie. Zasadniczo dane na żywo należy buforować krótko, a historyczne dane podsumowujące — przez kilka minut.

Błędy żądań

Nie powinno być konieczne analizowanie innego formatu dla każdego problemu. Błędy API korzystają ze spójnego formatu JSON ze stałym kodem czytelnym maszynowo.

HTTP Kod Opis
400 site_required Brakuje wymaganego parametru site.
401 missing_token Brakuje nagłówka Authorization.
401 invalid_token Token jest nieprawidłowy lub został unieważniony.
403 site_not_authorized Klucz API nie zapewnia dostępu do tego trackera.
429 rate_limit_exceeded Przekroczono limit żądań.
503 redis_unavailable Backend danych na żywo jest tymczasowo niedostępny. 
{
  "error": {
    "code": "invalid_token",
    "message": "Bearer token is invalid or revoked."
  }
}