Endpoint REST API

GET /v1/proofreading

Do 100 aktualnie widocznych sugestii korekty tekstu z ostatnio sprawdzonych artykułów jednego trackera.

Żądanie

GET https://api.nowmetrix.com/v1/proofreading?site=TRACKER_ID&limit=50

Ten endpoint służy do pobierania najnowszych aktualnych sugestii korekty tekstu dla autoryzowanego trackera. Wyniki oznaczone jako poprawione lub objęte aktywną regułą ignorowania są wykluczane.

Uwierzytelnianie

Wymagany jest klucz API w nagłówku Authorization: Authorization: Bearer nm_YOUR_KEY. Klucz musi zapewniać dostęp do wskazanego identyfikatora trackera.

Parametry zapytania

Nazwa Typ Wymagane Opis
site string wymagany Identyfikator trackera NowMetrix. Klucz API musi zapewniać dostęp do tego trackera. Nie należy przekazywać domeny publikacji.
limit integer opcjonalny Maksymalna liczba sugestii. Wartość domyślna to 50, a maksymalna — 100.

Przykład cURL

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

Przykładowa odpowiedź

{
  "site": "TRACKER_ID",
  "updated_at": "2026-01-15T09:30:00+00:00",
  "limit": 50,
  "count": 1,
  "issues": [
    {
      "id": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
      "checked_at": "2026-01-15T09:25:00+00:00",
      "article": {
        "title": "Example article",
        "url": "https://www.example.com/news/example-article"
      },
      "language": {
        "code": "en",
        "name": "English"
      },
      "category": {
        "code": "consistency",
        "label": "Article inconsistency"
      },
      "location": {
        "code": "body",
        "label": "Body"
      },
      "original": "Northwind Lab",
      "original_occurrence": 1,
      "correction": "Northwind Labs",
      "context": "The announcement was published by Northwind Lab on Monday.",
      "explanation": "The organization is named Northwind Labs elsewhere in the same article.",
      "confidence": "high"
    }
  ]
}

Pola odpowiedzi

Pole Typ Opis
site string Identyfikator trackera użyty w żądaniu.
updated_at string Znacznik czasu UTC wskazujący moment wygenerowania danych.
limit integer Obowiązujący limit wyników po walidacji i ograniczeniu maksymalnej wartości.
count integer Liczba zwróconych widocznych sugestii.
issues[] array<object> Widoczne sugestie uporządkowane malejąco według pola checked_at.
issues[].id string Nieprzezroczysty, stabilny identyfikator tego wystąpienia sugestii.
issues[].checked_at string Znacznik czasu UTC sprawdzenia artykułu, podczas którego wygenerowano bieżącą sugestię.
issues[].article object Tytuł artykułu i pełny adres URL. Wewnętrzne identyfikatory artykułów nie są udostępniane.
issues[].language object Wykryty kod języka i nazwa wyświetlana w interfejsie.
issues[].category object Kod kategorii do odczytu maszynowego oraz zlokalizowana etykieta. Kod consistency identyfikuje sprzeczności w obrębie artykułu dotyczące nazw lub szczegółów faktycznych, takich jak liczby, daty, godziny, wiek, lokalizacje i role.
issues[].location object Kod sekcji artykułu i zlokalizowana etykieta.
issues[].original string Oryginalny tekst zidentyfikowany przez funkcję korekty tekstu.
issues[].original_occurrence integer|null Numer wystąpienia oryginalnego tekstu w kontekście, liczony od 1. W starszych wynikach może mieć wartość null, jeśli powtarzającego się tekstu nie można jednoznacznie zlokalizować.
issues[].correction string Sugerowana poprawka.
issues[].context string Ujednolicony kontekst artykułu o ograniczonej długości.
issues[].explanation string Wyjaśnienie sugestii.
issues[].confidence string Poziom pewności zaakceptowany przez proces korekty tekstu.

Aktualność danych i buforowanie

Odpowiedzi są przechowywane w mikrobuforze osobno dla każdego trackera i limitu przez 30 sekund. Odpowiedź zawiera nagłówek X-NowMetrix-Microcache z wartością HIT lub MISS. Pole checked_at wskazuje czas sprawdzenia artykułu; endpoint nie jest historią pierwszych wykryć, do której dane są tylko dopisywane.

Błędy

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 czasu rzeczywistego jest tymczasowo niedostępny.
409 proofreading_not_enabled Funkcja korekty tekstu nie jest włączona dla żądanego trackera.
500 encoding_failed Nie udało się zakodować odpowiedzi.
503 database_unavailable Baza danych korekty tekstu jest tymczasowo niedostępna.
503 proofreading_unavailable Nie udało się wygenerować źródła sugestii korekty tekstu. 
{
  "error": {
    "code": "proofreading_not_enabled",
    "message": "Proofreading is not enabled for this tracker."
  }
}