REST API

Ενσωματώστε τα δεδομένα του NowMetrix στα εργαλεία που ήδη χρησιμοποιεί η ομάδα σας.

Ξεκινήστε με ένα στιγμιότυπο σε πραγματικό χρόνο, δημιουργήστε μια οθόνη για την αίθουσα σύνταξης ή στείλτε ιστορικά αποτελέσματα στη ροή εργασίας αναφορών σας. Επιλέξτε εδώ ένα endpoint και ανοίξτε την πλήρη τεχνική αναφορά του.

Συνδέστε την εφαρμογή σας

Είναι η πρώτη σας επαφή με το API; Ξεκινήστε με τον πλήρη οδηγό σύνδεσης. Εξηγεί πώς να δημιουργήσετε και να προστατεύσετε ένα API key, να το επαληθεύσετε με το /api/me και να υποβάλετε το ίδιο εξουσιοδοτημένο αίτημα από δημοφιλείς γλώσσες προγραμματισμού.

Άνοιγμα του οδηγού σύνδεσης

Ξεκινήστε με ένα βασικό URL

Κάθε αίτημα με έλεγχο ταυτότητας μέσω API key ξεκινά από αυτόν τον host:

https://api.nowmetrix.com

Στείλτε το API key σας

Στείλτε ένα API key ως Bearer token στην κεφαλίδα Authorization. Οι διαχειριστές λογαριασμού και τα μέλη ομάδας με πρόσβαση στο API μπορούν να δημιουργήσουν και να ονομάσουν έως 10 ενεργά κλειδιά στον πίνακα ελέγχου του NowMetrix, στην ενότητα Ρυθμίσεις -> API.

Authorization: Bearer nm_YOUR_KEY

Απαιτείται HTTPS. Όλα τα κλειδιά χρησιμοποιούν τα δικαιώματα του αντίστοιχου χρήστη NowMetrix και μοιράζονται το όριο χρήσης κάθε tracker.

Πραγματοποιήστε το πρώτο σας αίτημα

Ο πιο γρήγορος τρόπος να ελέγξετε τη ρύθμισή σας είναι ένα στιγμιότυπο σε πραγματικό χρόνο. Επιβεβαιώνει ότι το κλειδί λειτουργεί και ότι μπορεί να αποκτήσει πρόσβαση στον tracker.

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

Επιλέξτε τα δεδομένα που χρειάζεστε

Μέθοδος Διαδρομή Περιγραφή Αναφορά
GET /v1/realtime Τρέχον στιγμιότυπο σε πραγματικό χρόνο: ενεργοί χρήστες, Προβολές, κορυφαίες σελίδες, συσκευές, χώρες, πόλεις και πηγές. Προβολή endpoint
GET /v1/sources Πηγές επισκεψιμότητας από το τρέχον παράθυρο σε πραγματικό χρόνο, με κατηγοριοποίηση και προαιρετικές εγγραφές-παιδιά. Προβολή endpoint
GET /v1/overview Ημερήσιες Προβολές σελίδας και επισκέψεις για τις τελευταίες N ολοκληρωμένες εγγραφές ιστορικού. Προβολή endpoint
GET /v1/recap Δεδομένα Recap, συνοπτικές μετρήσεις και κορυφαίες σελίδες για προκαθορισμένο ή προσαρμοσμένο εύρος ημερομηνιών. Προβολή endpoint
GET /v1/pulse Η σημερινή εικόνα, σύγκριση με τη χθεσινή ημέρα και ενδοημερήσιες καμπύλες ανά 15 λεπτά. Προβολή endpoint
GET /v1/proofreading Έως 100 τρέχουσες ορατές προτάσεις γλωσσικού ελέγχου από τα πιο πρόσφατα ελεγμένα άρθρα ενός tracker. Προβολή endpoint
GET /v1/responsibilities Τρέχουσες αρμοδιότητες ομάδας για έναν tracker, συμπεριλαμβανομένων των ατόμων που έχουν αναλάβει κάθε ορατό ρόλο. Προβολή endpoint
GET /api/me Πλαίσιο λογαριασμού API key: ο τρέχων tracker και όλοι οι tracker στους οποίους έχει πρόσβαση το token. Προβολή endpoint

Διατηρήστε τα αιτήματα γρήγορα και προβλέψιμα

Το δημόσιο API επιτρέπει 20 αιτήματα ανά λεπτό για κάθε tracker. Πολλοί χρήστες ή κλειδιά που υποβάλλουν ερωτήματα στον ίδιο tracker μοιράζονται τον ίδιο μετρητή.

X-RateLimit-Limit: 20
X-RateLimit-Remaining: 7
X-RateLimit-Reset: 1783612801
Retry-After: 42
Αποθηκεύετε προσωρινά τις αποκρίσεις του API στο δικό σας σύστημα όποτε είναι δυνατό. Κατά κανόνα, αποθηκεύετε προσωρινά τα δεδομένα πραγματικού χρόνου για σύντομο διάστημα και τα ιστορικά δεδομένα επισκόπησης για αρκετά λεπτά.

Όταν ένα αίτημα αποτυγχάνει

Δεν θα πρέπει να χρειάζεται να αναλύετε διαφορετική μορφή για κάθε πρόβλημα. Τα σφάλματα του API χρησιμοποιούν συνεπές σώμα JSON με σταθερό, αναγνώσιμο από μηχανές κωδικό.

HTTP Κωδικός Περιγραφή
400 site_required Λείπει η απαιτούμενη παράμετρος site.
401 missing_token Λείπει η κεφαλίδα Authorization.
401 invalid_token Το token δεν είναι έγκυρο ή έχει ανακληθεί.
403 site_not_authorized Το API key δεν έχει πρόσβαση σε αυτόν τον tracker.
429 rate_limit_exceeded Έχει ξεπεραστεί το όριο χρήσης.
503 redis_unavailable Το backend πραγματικού χρόνου δεν είναι προσωρινά διαθέσιμο. 
{
  "error": {
    "code": "invalid_token",
    "message": "Bearer token is invalid or revoked."
  }
}