REST API

Unesite podatke iz NowMetrixa u alate koje Vaš tim već upotrebljava.

Započnite snimkom podataka uživo, izradite prikaz za redakciju ili pošaljite povijesne rezultate u svoj izvještajni tijek rada. Odaberite krajnju točku, a zatim otvorite njezinu potpunu tehničku referencu.

Povežite svoju aplikaciju

Prvi put upotrebljavate API? Započnite s potpunim vodičem za povezivanje. U njemu je objašnjeno kako izraditi i zaštititi API ključ, provjeriti ga putem /api/me te uobičajenim programskim jezicima poslati isti autentificirani zahtjev.

Otvoriti vodič za povezivanje

Započnite s jednim osnovnim URL-om

Svaki zahtjev autentificiran API ključem započinje ovim hostom:

https://api.nowmetrix.com

Pošaljite svoj API ključ

Pošaljite API ključ kao Bearer token u zaglavlju Authorization. Administratori računa i članovi tima s pristupom API-ju mogu izraditi i označiti do 10 aktivnih ključeva na nadzornoj ploči NowMetrixa u odjeljku Postavke -> API.

Authorization: Bearer nm_YOUR_KEY

HTTPS je obavezan. Svi ključevi upotrebljavaju dopuštenja svojeg korisnika NowMetrixa i dijele ograničenje broja zahtjeva za svaki tracker.

Pošaljite svoj prvi zahtjev

Najbrži način provjere postavljanja jest snimka podataka u stvarnom vremenu. Njome se potvrđuje da ključ radi i da može pristupiti trackeru.

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

Odaberite podatke koji su Vam potrebni

Metoda Putanja Opis Referenca
GET /v1/realtime Trenutačna snimka podataka uživo: aktivni korisnici, pregledi stranica, najpopularnije stranice, uređaji, države, gradovi i izvori. Pregledati krajnju točku
GET /v1/sources Izvori prometa iz trenutačnog prozora podataka uživo s klasifikacijom i neobaveznim podređenim retcima. Pregledati krajnju točku
GET /v1/overview Dnevni pregledi stranica i posjeti za posljednjih N dovršenih povijesnih zapisa. Pregledati krajnju točku
GET /v1/recap Podaci značajke Recap, sažete metrike i najpopularnije stranice za unaprijed definirana razdoblja ili prilagođeni raspon datuma. Pregledati krajnju točku
GET /v1/pulse Podaci za današnji Pulse, usporedba s jučerašnjim danom i krivulje unutar dana u intervalima od 15 minuta. Pregledati krajnju točku
GET /v1/proofreading Do 100 trenutačno vidljivih prijedloga za provjeru teksta iz posljednje provjerenih članaka jednog trackera. Pregledati krajnju točku
GET /v1/responsibilities Trenutačne odgovornosti tima za tracker, uključujući osobe kojima je dodijeljena svaka vidljiva uloga. Pregledati krajnju točku
GET /api/me Kontekst računa API ključa: trenutačni tracker i svi trackeri kojima token može pristupiti. Pregledati krajnju točku

Neka zahtjevi budu brzi i predvidljivi

Javni API dopušta 20 zahtjeva u minuti po trackeru. Više korisnika ili ključeva koji šalju upite istom trackeru dijele isti brojač.

X-RateLimit-Limit: 20
X-RateLimit-Remaining: 7
X-RateLimit-Reset: 1783612801
Retry-After: 42
Kad god je moguće, predmemorirajte odgovore API-ja u vlastitom sustavu. Kao opće pravilo, podatke u stvarnom vremenu predmemorirajte kratko, a povijesne podatke pregleda nekoliko minuta.

Kada zahtjev ne uspije

Ne biste trebali analizirati drukčiji format za svaki problem. Pogreške API-ja upotrebljavaju ujednačeno JSON tijelo sa stabilnim strojno čitljivim kodom.

HTTP Kôd Opis
400 site_required Nedostaje obavezni parametar site.
401 missing_token Nedostaje zaglavlje Authorization.
401 invalid_token Token nije valjan ili je opozvan.
403 site_not_authorized API ključ nema pristup ovom trackeru.
429 rate_limit_exceeded Prekoračeno je ograničenje broja zahtjeva.
503 redis_unavailable Sustav u pozadini za podatke u stvarnom vremenu trenutačno nije dostupan. 
{
  "error": {
    "code": "invalid_token",
    "message": "Bearer token is invalid or revoked."
  }
}