REST API

Iegūstiet NowMetrix datus rīkos, kurus Jūsu komanda jau izmanto.

Sāciet ar aktuālo momentuzņēmumu, izveidojiet redakcijas informācijas paneli vai nosūtiet vēsturiskos rezultātus uz pārskatu sagatavošanas darbplūsmu. Izvēlieties galapunktu un atveriet tā pilno tehnisko aprakstu.

Savienojiet savu lietotni

Vai API Jums ir jaunums? Sāciet ar pilno savienojuma rokasgrāmatu. Tajā paskaidrots, kā izveidot un aizsargāt API atslēgu, pārbaudīt to, izmantojot /api/me, un nosūtīt tādu pašu autentificētu pieprasījumu, izmantojot izplatītākās programmēšanas valodas.

Atvērt savienojuma rokasgrāmatu

Sāciet ar vienu bāzes URL

Katrs ar API atslēgu autentificēts pieprasījums sākas ar šo resursdatoru:

https://api.nowmetrix.com

Nosūtiet savu API atslēgu

Nosūtiet API atslēgu kā Bearer tokenu Authorization galvenē. Kontu administratori un komandas dalībnieki ar API piekļuvi var NowMetrix informācijas panelī sadaļā Iestatījumi -> API izveidot un nosaukt līdz 10 aktīvām atslēgām.

Authorization: Bearer nm_YOUR_KEY

HTTPS ir obligāts. Visas atslēgas izmanto tām piesaistītā NowMetrix lietotāja atļaujas, un tām ir kopīgs tracker ātruma ierobežojums.

Nosūtiet savu pirmo pieprasījumu

Ātrākais veids, kā pārbaudīt iestatījumus, ir pieprasīt reāllaika momentuzņēmumu. Tas apstiprina, ka atslēga darbojas un var piekļūt tracker.

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

Izvēlieties nepieciešamos datus

Metode Ceļš Apraksts Atsauce
GET /v1/realtime Pašreizējais reāllaika momentuzņēmums: aktīvie lietotāji, lapu skatījumi, populārākās lapas, ierīces, valstis, pilsētas un avoti. Skatīt galapunktu
GET /v1/sources Apmeklējumu avoti pašreizējā reāllaika periodā ar klasifikāciju un pēc izvēles arī pakārtotajām rindām. Skatīt galapunktu
GET /v1/overview Dienas lapu skatījumi un apmeklējumi par pēdējām N pabeigtajām vēstures rindām. Skatīt galapunktu
GET /v1/recap Recap dati, kopsavilkuma rādītāji un populārākās lapas iepriekš iestatītiem periodiem vai pielāgotam datumu diapazonam. Skatīt galapunktu
GET /v1/pulse Šodienas pulse dati, salīdzinājums ar vakardienu un dienas 15 minūšu līknes. Skatīt galapunktu
GET /v1/proofreading Līdz 100 pašlaik redzamiem korektūras ieteikumiem no viena tracker nesenāk pārbaudītajiem rakstiem. Skatīt galapunktu
GET /v1/responsibilities Pašreizējās komandas atbildības jomas tracker, tostarp informācija par katrai redzamajai lomai piešķirtajām personām. Skatīt galapunktu
GET /api/me API atslēgas konta konteksts: pašreizējais tracker un visi tracker, kuriem tokenam ir piekļuve. Skatīt galapunktu

Nodrošiniet ātrus un paredzamus pieprasījumus

Publiskais API pieļauj 20 pieprasījumus minūtē katram tracker. Vairākiem lietotājiem vai atslēgām, kas vaicā vienu un to pašu tracker, ir kopīgs skaitītājs.

X-RateLimit-Limit: 20
X-RateLimit-Remaining: 7
X-RateLimit-Reset: 1783612801
Retry-After: 42
Kad vien iespējams, saglabājiet API atbildes kešatmiņā savā sistēmā. Parasti reāllaika dati kešatmiņā jāsaglabā īslaicīgi, bet vēsturiskie pārskata dati — vairākas minūtes.

Ja pieprasījums neizdodas

Jums nevajadzētu katrai problēmai analizēt atšķirīgu formātu. API kļūdām ir vienots JSON pamatteksts ar stabilu, mašīnlasāmu kodu.

HTTP Kods Apraksts
400 site_required Trūkst obligātā site parametra.
401 missing_token Trūkst Authorization galvenes.
401 invalid_token Tokens nav derīgs vai ir atsaukts.
403 site_not_authorized API atslēgai nav piekļuves šim tracker.
429 rate_limit_exceeded Pārsniegts ātruma ierobežojums.
503 redis_unavailable Reāllaika aizmugursistēma īslaicīgi nav pieejama. 
{
  "error": {
    "code": "invalid_token",
    "message": "Bearer token is invalid or revoked."
  }
}