Krijg inzicht in de resultaten van het helpcentrum met de Notiondesk API.

De Notiondesk API geeft je inzicht in de cijfers achter de analysepagina's van je helpcentrum: bezoekers, artikelweergaven, tijd doorgebracht op de pagina, landen, waar lezers naar zoeken, welke zoekopdrachten geen resultaten opleveren en hoe lezers reageren op je artikelen. Gebruik de API om een ​​BI-tool te voeden, een wekelijks rapport naar Slack te sturen of de content te vinden die je lezers missen.

GET /sites/{site_id}/analytics/{report}

Elk rapport heeft het bereik read nodig. Zie Hoe u uw helpcentrum kunt verbeteren met lezersinzichten om deze cijfers in het dashboard te lezen.

Ontvang een samenvatting van 30 dagen.

quick omvat de laatste 30 dagen tot nu toe en accepteert geen queryparameter. articles telt elk artikel in het helpcentrum, inclusief concepten. reactions telt de meest recente reactie van elke lezer per artikel.

Vraag een rapport aan voor een specifiek datumbereik.

overview, search en engagement vereisen een datumbereik en een bucketgrootte:

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/analytics/quick" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

{
  "articles": 42,
  "visitors": 25,
  "searches": 9,
  "reactions": 4
}

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/analytics/search?start_date=2026-09-01T00:00:00Z&end_date=2026-10-01T00:00:00Z&date_scale=week&timezone=Europe/Paris" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

Regels voor de schietbaan:

• Datums worden weergegeven in het formaat YYYY-MM-DDTHH:MM[:SS] met een optionele offset. Zonder offset wordt de datum gelezen als UTC, niet in timezone. Schrijf + als %2B in de URL, of gebruik Z.

• De actieperiode begint op of na 1 januari 2020 en eindigt uiterlijk over twee dagen.

• Maximaal 1000 emmers. Bijvoorbeeld, minute dekt maximaal 16 uur en hour maximaal 41 dagen. Gebruik de grovere date_scale voor langere periodes.

• De weken beginnen op maandag.

Elk rapport vergelijkt uw bereik met de periode van dezelfde lengte die eraan voorafging: previous en total_previous beschrijven die eerdere periode.

Telreeksen

visitors, article_views en searches hebben één vorm gemeen:

{
  "total": 12,
  "total_previous": 8,
  "difference": 4,
  "percentage_difference": 50.0,
  "current": [{"date": "2026-09-14", "count": 7}, {"date": "2026-09-15", "count": 5}],
  "previous": [{"date": "2026-08-20", "count": 8}]
}

• current en previous tonen alleen de buckets die gegevens bevatten, van oudst naar nieuw.

• De date van een emmer is wanneer deze begint, in timezone: YYYY-MM-DD voor day en grover, YYYY-MM-DDTHH:MM voor hour en minute.

• percentage_difference is 0.0 wanneer het vorige totaal 0 is.

overview

search

{
  "searches_without_results": {
    "total": 3,
    "total_previous": 0,
    "difference": 3,
    "percentage_difference": 0.0,
    "queries": [{"query": "refund policy", "searches": 3}]
  }
}

Let op: dit is uw contentbacklog: elke zoekopdracht is een vraag die lezers hebben gesteld en die uw helpcentrum niet kon beantwoorden. searches_without_results.queries

engagement

Een reaction_summary volgt jouw reactiestijl:

score loopt van 0 tot 100: het aandeel positieve reacties, waarbij een neutrale reactie voor de helft meetelt onder emoji. Bij de stijl thumbs zijn de groepen helpful en not_helpful. Zie Hoe feedback te verzamelen met artikelreacties .

Lijstlimieten

{
  "style": "emoji",
  "total": 6,
  "score": 58,
  "groups": [
    {"key": "positive", "count": 3, "percent": 50},
    {"key": "neutral", "count": 1, "percent": 17},
    {"key": "negative", "count": 2, "percent": 33}
  ]
}

• De querylijsten top_articles, top_referrers, article_engagements en articles_to_revise bevatten elk maximaal 50 rijen en hebben alleen betrekking op de huidige periode. Een lijst van 50 rijen kan onvolledig zijn: verklein het bereik om alle rijen te zien.

• De totalen omvatten alles, niet alleen de vermelde rijen.

titleDeze links zijn afkomstig uit de browsers van bezoekers en kunnen door iedereen worden vervalst. Ontsnap eraan voordat je ze weergeeft en volg of reageer er nooit op zonder ze te controleren.urlhostpathnamereferrerquery

Analyses en uw plan

Voor API-toegang is een Enterprise-abonnement vereist, dat geavanceerde analyses omvat, waardoor elk rapport elk bereik en elke schaal tot 1000 buckets accepteert.

Snelheidslimiet

Naast de 120 leesbewerkingen per minuut van uw sleutel, tellen analyserapporten mee voor een budget van 30 aanvragen per minuut per helpcentrum , dat wordt gedeeld door elke sleutel en OAuth-app in uw werkruimte. Een aanvraag via dit budget beantwoordt met 429 rate_limited, en de header Retry-After geeft aan wanneer een nieuwe poging moet worden gedaan. Cache rapporten in plaats van ze bij elke paginalading op te vragen.

Fouten

Zie Foutmeldingen, snelheidslimieten en herhaalpogingen van de Notiondesk API afhandelen .

Veelgestelde vragen

Wat volgt?

• Exporteer lezersfeedback met de Notiondesk API

• Automatiseer veelvoorkomende helpcentrumtaken met de Notiondesk API

• Verwerk API-fouten, snelheidslimieten en herhaalpogingen voor Notiondesk.