Microsoft Clarity koppelen | Helpcentrum

Wat je nodig hebt

De rol Admin of Member in je organisatie. Viewers hebben geen toegang tot Koppelen. Zie Wie mag koppelen?.
Tweestapsverificatie (2FA) op je APIboard-account.
Een vrije plek in je pakket: Proefperiode en Basis 3 koppelingen, Team 7, Pro 10 (plus eventueel een gekochte extra koppeling).
De rol beheerder in het Clarity-project. Alleen een beheerder van het project kan een API-token maken.
Besef dat Clarity geen historie levert: de cijfers beginnen op de dag van koppelen.

Verbinden

Ga in APIboard naar Koppelen > Koppelingen.
Zoek Microsoft Clarity bij Beschikbare koppelingen (of typ de naam in het zoekveld) en klik op de kaart. Er opent een venster dat je stap voor stap begeleidt.
Open Microsoft Clarity en kies het project van je website.
Ga naar Settings > Overview en kopieer de Project ID. Het dashboardadres plakken mag ook.
Ga naar Settings > Data Export en klik op Generate new API token.
Geef het token een naam van 4 tot 32 tekens (letters, cijfers, - _ en .), bijvoorbeeld APIboard.
Kopieer het token meteen: Clarity toont het maar één keer.
Vul in APIboard het Project-ID en het API-token in. Vul eventueel een Naam voor deze koppeling (optioneel) in.
Klik op Koppelen.
APIboard haalt direct de eerste gegevens op (Data wordt opgehaald…). Daarna zie je Verbonden met Microsoft Clarity, met de dashboards die klaarstaan. Op Koppelen > Koppelingen staat de pil Bezig met ophalen… tot de eerste volledige ronde klaar is; daarna staat er Actief.

Account of administratie kiezen

Er is geen keuzescherm: één token hoort bij één Clarity-project. Heb je meer projecten, koppel ze dan elk met een eigen project-ID en token.

Welke gegevens je krijgt

Onderwerp	Tabellen
Dagcijfers	Dagtotalen, Toplijsten
Pagina’s	Pagina’s
Herkomst en bezoekers	Herkomst, Apparaat en land

Je vraagt de gegevens op via de API en ziet ze in de Datawerkbank. Alle tabellen en velden staan in de API-documentatie van Microsoft Clarity.

Hoe vaak vernieuwd

Clarity levert via de API alleen de laatste 24 uur als één totaal, zonder datum. Bij het koppelen haalt APIboard direct een voorlopige ronde op (de cijfers van de afgelopen 24 uur, als voorlopig gemarkeerd). Daarna haalt APIboard elke dag om 03:00 (Amsterdam) de cijfers van de vorige dag op; die vervangen de voorlopige cijfers. Dit geldt voor alle pakketten. Je historie bouwt zich dus op vanaf de dag van koppelen.

Hoe vaak dat gebeurt, hangt af van je pakket (Proefperiode, Basis, Team of Pro): zie Hoe vaak worden gegevens vernieuwd?.

Goed om te weten

Clarity staat maar 10 aanroepen per project per dag toe. APIboard houdt een lager plafond aan en probeert het na een mislukte ronde opnieuw.
Per ronde vraagt APIboard 4 keer iets op: het totaal, de pagina’s, de herkomst en apparaat met land. URL-waarden worden na 500 tekens afgekapt.
Kanalen en apparaten staan in het Nederlands, zoals Direct, Organisch zoeken, Betaald zoeken, Social, Computer en Mobiel.
Opnieuw verbinden vervangt alleen je inloggegevens. De koppeling, alle opgehaalde gegevens en de syncstand blijven staan, de status gaat terug naar Actief en de volgende synchronisatie haalt alleen wijzigingen op. Het verbindscherm opent direct, zonder bevestigingsvraag. Vul dezelfde project-ID in en plak een nieuw API-token. Log je in met een ander account, dan weigert APIboard dat met de melding “Dit is een ander account dan de koppeling die je opnieuw verbindt. Log in met hetzelfde account.” Dan is het een nieuwe koppeling.
Je vindt Opnieuw verbinden (pijlicoon) in het zijpaneel dat opent als je op de kaart van de koppeling klikt.
Een koppeling of account verwijderen (Koppeling verwijderen of het verwijderpictogram bij een account) wist ook alle opgehaalde gegevens. Dat kan niet ongedaan worden gemaakt.

Problemen oplossen

Dit is geen Clarity Data Export-token. Je hebt een token geplakt dat niet voor Data Export is gemaakt. Maak het onder Settings > Data Export.
Vul je Clarity API-token in. Het tokenveld is leeg.
Vul de project-id van je Clarity-project in (Settings, Overview). Het veld Project-ID is leeg.
Clarity accepteert dit token niet. Maak een nieuw token aan en probeer het opnieuw. Het token is ingetrokken, verlopen of onvolledig gekopieerd.
Je hebt vandaag al vaak geprobeerd Clarity te koppelen. Probeer het morgen opnieuw. Er geldt een limiet op het aantal pogingen per dag. Probeer het morgen nog eens.
De Clarity-limiet voor vandaag is bereikt, probeer het morgen opnieuw. Clarity staat maar een beperkt aantal aanroepen per dag toe. Probeer het morgen opnieuw.
APIboard haalt op dit moment gegevens op voor dit Clarity-project. Probeer het over een paar minuten opnieuw. Wacht even tot de lopende ophaalronde klaar is.
Clarity is nu niet bereikbaar. Probeer het later opnieuw. Een storing bij Clarity. Probeer het later nog eens.
Clarity gaf een onverwacht antwoord. Probeer het later opnieuw. Probeer het later nog eens. Houdt het aan, neem dan contact op met support.
Dit Clarity-project is al gekoppeld. Dit project staat al in je organisatie.
Viewers kunnen geen koppelingen beheren. Je hebt de rol Viewer. Vraag een Admin van je organisatie om je de rol Member te geven, of om de koppeling te maken.
Dit account is al gekoppeld. Wat je probeert te koppelen, staat al in je organisatie. Zoek het op onder Koppelen > Koppelingen.
Je hebt je koppelingen-limiet bereikt voor je pakket. (of Je hebt je accounts-limiet bereikt voor je pakket.) Kies Bekijk abonnementen om te upgraden, of koop een extra koppeling of extra account.
De pil Fout bij de koppeling. Een synchronisatie is mislukt of de toegang is verlopen of ingetrokken. APIboard probeert het bij een tijdelijke fout later zelf opnieuw; bij een verlopen toegang gebruik je Opnieuw verbinden.