Naar de inhoud

Uw gegevens lezen via de API

Alles wat de interface toont, is programmatisch leesbaar, met dezelfde filters en dezelfde periodes.

Kort samengevat

Een lees-API stelt uw statistieken beschikbaar in JSON, met een persoonlijke sleutel. Ze dient om een intern dashboard, een geautomatiseerd rapport of een extern hulpmiddel te voeden.

Een sleutel verkrijgen

Sleutels maakt u aan vanuit uw profiel. Een sleutel geeft leestoegang tot alle sites van uw account en kan op elk moment worden ingetrokken.

Ze wordt in de autorisatieheader meegestuurd. Publiceer haar niet in code die door een browser wordt uitgevoerd: iedereen zou ze daar kunnen lezen.

De eindpunten

  • /api/v1/sites geeft de toegankelijke sites en hun identificatoren.
  • /api/v1/stats geeft een volledig dashboard voor een site en een periode.
  • /api/v1/realtime geeft de actieve bezoekers.

Eén oproep geeft een volledig dashboard terug, ook als u maar één meetwaarde wilt. De snelheid is begrensd: bundel uw behoeften in één oproep in plaats van ze te vermenigvuldigen.

Filteren

Filters gaan mee als parameters, in de vorm filters[dimensie]=waarde. De aanvaarde dimensies staan in de technische documentatie.

Een onbekende dimensie wordt stilzwijgend genegeerd: het antwoord komt volledig terug, zonder toegepaste filter en zonder fout. Controleer de exacte naam van de dimensie als uw cijfers te hoog lijken.

Mist u een antwoord? Schrijf ons. Wij antwoorden zelf en vullen deze gids aan.

Een vraag stellen