REST API galapunkts

GET /v1/proofreading

Līdz 100 pašlaik redzamiem korektūras ieteikumiem no viena tracker nesen pārbaudītajiem rakstiem.

Pieprasījums

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

Izmantojiet šo galapunktu, lai izgūtu jaunākos pašreizējos korektūras ieteikumus autorizētam tracker. Rezultāti, kas atzīmēti kā izlaboti vai uz kuriem attiecas aktīvs ignorēšanas noteikums, netiek iekļauti.

Autentifikācija

Nepieciešama API atslēga Authorization galvenē: Authorization: Bearer nm_YOUR_KEY. Atslēgai ir jānodrošina piekļuve pieprasītajam tracker ID.

Vaicājuma parametri

Nosaukums Tips Nepieciešams Apraksts
site string nepieciešams NowMetrix izsekošanas ID. API atslēgai ir jānodrošina piekļuve šim tracker. Nenorādiet izdevuma domēnu.
limit integer neobligāts Maksimālais ieteikumu skaits. Noklusējuma vērtība ir 50, bet maksimālā vērtība — 100.

cURL piemērs

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

Atbildes piemērs

{
  "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"
    }
  ]
}

Atbildes lauki

Lauks Tips Apraksts
site string Pieprasījumā izmantotais izsekošanas ID.
updated_at string UTC laika zīmogs, kas norāda, kad tika izveidoti atbildes dati.
limit integer Efektīvais rezultātu ierobežojums pēc validēšanas un maksimālās vērtības piemērošanas.
count integer Atgriezto redzamo ieteikumu skaits.
issues[] array<object> Redzamie ieteikumi, sakārtoti dilstošā secībā pēc checked_at.
issues[].id string Necaurspīdīgs, stabils šī ieteikuma gadījuma identifikators.
issues[].checked_at string UTC laika zīmogs raksta pārbaudei, kuras rezultātā tika izveidots pašreizējais ieteikums.
issues[].article object Raksta nosaukums un pilnais URL. Iekšējie rakstu ID netiek izpausti.
issues[].language object Noteiktās valodas kods un attēlojamais nosaukums.
issues[].category object Mašīnlasāms kategorijas kods un lokalizēts apzīmējums. consistency kods apzīmē raksta iekšējas pretrunas nosaukumos vai faktiskajā informācijā, piemēram, skaitļos, datumos, laikos, vecumā, atrašanās vietās un lomās.
issues[].location object Raksta sadaļas kods un lokalizēts apzīmējums.
issues[].original string Korektūras pārbaudē identificētais sākotnējais teksts.
issues[].original_occurrence integer|null Sākotnējā teksta parādīšanās reize kontekstā, skaitot no 1. Mantotiem rezultātiem vērtība var būt null, ja atkārtotu tekstu nav iespējams nepārprotami atrast.
issues[].correction string Ieteiktais labojums.
issues[].context string Normalizēts un pēc garuma ierobežots raksta konteksts.
issues[].explanation string Ieteikuma skaidrojums.
issues[].confidence string Uzticamības līmenis, ko pieņem korektūras apstrādes process.

Datu aktualitāte un kešošana

Atbildes tiek mikrokešotas 30 sekundes katram tracker un limit vērtību pārim. Atbildē ir ietverta X-NowMetrix-Microcache galvene ar vērtību HIT vai MISS. checked_at ir raksta pārbaudes laiks; galapunkts nav tikai pirmo konstatējumu papildināma vēsture.

Kļūdas

HTTP Kods Apraksts
400 site_required Trūkst nepieciešamā 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 pieprasījumu biežuma ierobežojums.
503 redis_unavailable Reāllaika aizmugursistēma īslaicīgi nav pieejama.
409 proofreading_not_enabled Pieprasītajam tracker nav iespējota korektūra.
500 encoding_failed Atbildi neizdevās kodēt.
503 database_unavailable Korektūras datubāze īslaicīgi nav pieejama.
503 proofreading_unavailable Korektūras datu plūsmu neizdevās izveidot.
{
  "error": {
    "code": "proofreading_not_enabled",
    "message": "Proofreading is not enabled for this tracker."
  }
}