REST API

Využijte data z NowMetrix v nástrojích, které váš tým už používá.

Začněte živým snímkem, vytvořte redakční obrazovku nebo odešlete historické výsledky do svého pracovního postupu pro reporting. Vyberte endpoint a otevřete jeho kompletní technickou referenci.

Připojte svou aplikaci

Začínáte s API? Začněte kompletním průvodcem připojením. Vysvětluje, jak vytvořit a zabezpečit klíč API, ověřit ho pomocí /api/me a odeslat stejný autentizovaný požadavek z běžných programovacích jazyků.

Otevřít průvodce připojením

Začněte jednou základní URL

Každý požadavek ověřený klíčem API začíná tímto hostitelem:

https://api.nowmetrix.com

Odešlete klíč API

Odešlete klíč API jako Bearer token v hlavičce Authorization. Správci účtu a členové týmu s přístupem k API mohou v přehledovém panelu NowMetrix v části Nastavení -> API vytvořit a označit až 10 aktivních klíčů.

Authorization: Bearer nm_YOUR_KEY

Je vyžadováno HTTPS. Všechny klíče používají oprávnění svého uživatele NowMetrix a sdílejí limit požadavků daného trackeru.

Odešlete svůj první požadavek

Nejrychleji své nastavení otestujete pomocí živého snímku. Ověříte tak, že klíč funguje a má přístup k trackeru.

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

Vyberte potřebná data

Metoda Cesta Popis Odkaz
GET /v1/realtime Aktuální živý snímek: aktivní uživatelé, zobrazení stránek, nejčtenější stránky, zařízení, země, města a zdroje návštěvnosti. Zobrazit endpoint
GET /v1/sources Zdroje návštěvnosti z aktuálního živého okna s klasifikací a volitelnými podřízenými řádky. Zobrazit endpoint
GET /v1/overview Počet zobrazení stránek a návštěv za posledních N dokončených řádků historických dat. Zobrazit endpoint
GET /v1/recap Data Recap, souhrnné metriky a nejčtenější stránky pro přednastavená nebo vlastní období. Zobrazit endpoint
GET /v1/pulse Dnešní Pulse, srovnání se včerejškem a průběhy během dne po 15 minutách. Zobrazit endpoint
GET /v1/proofreading Až 100 aktuálně viditelných návrhů kontroly textu z naposledy zkontrolovaných článků jednoho trackeru. Zobrazit endpoint
GET /v1/responsibilities Aktuální odpovědnosti týmu pro tracker včetně osob přiřazených ke každé viditelné roli. Zobrazit endpoint
GET /api/me Kontext účtu klíče API: aktuální tracker a všechny trackery, ke kterým má token přístup. Zobrazit endpoint

Udržujte požadavky rychlé a předvídatelné

Veřejné API umožňuje 20 požadavků za minutu na jeden tracker. Více uživatelů nebo klíčů, které se dotazují na stejný tracker, sdílí stejný čítač.

X-RateLimit-Limit: 20
X-RateLimit-Remaining: 7
X-RateLimit-Reset: 1783612801
Retry-After: 42
Odpovědi API podle možností ukládejte do mezipaměti ve vlastním systému. Obecně platí, že živá data stačí ukládat krátce, zatímco historická data z přehledu několik minut.

Když požadavek selže

Neměli byste pro každý problém zpracovávat jiný formát. Chyby API používají jednotné tělo JSON se stabilním strojově čitelným kódem.

HTTP Kód Popis
400 site_required Chybí povinný parametr site.
401 missing_token Chybí hlavička Authorization.
401 invalid_token Token je neplatný nebo byl odvolán.
403 site_not_authorized Klíč API nemá k tomuto trackeru přístup.
429 rate_limit_exceeded Byl překročen limit požadavků.
503 redis_unavailable Backend Realtime je dočasně nedostupný. 
{
  "error": {
    "code": "invalid_token",
    "message": "Bearer token is invalid or revoked."
  }
}