API-documentatie

Dit is de documentatie van onze API-endpoints. De API volgt de REST-architectuur. Elk endpoint geeft een JSON-antwoord terug met de standaard HTTP-statuscodes. Je logt in met Bearer Authentication via een API-sleutel.

 

Inloggen

Elk API-endpoint vraagt om een API-sleutel. Stuur die sleutel mee via de Bearer Authentication-methode.

Authorization: Bearer {api_key}
curl --request GET \
--url 'https://basicwebstats.com/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

Errors

Our API uses conventional HTTP status codes to indicate the success or failure of a request.

{
    "errors": [
        {
            "title": "Je hebt geen toegang tot de API.",
            "status": 401
        }
    ]
}
200 Request completed successfully
400 Bad request - Required parameters are missing or invalid
401 Unauthorized - API key is missing or invalid
404 The requested resource was not found
429 Too many requests - Rate limit exceeded
500 Internal server error - this means there is a problem on our end
Alle antwoorden van de API gebruiken de tijdzone UTC, tenzij we iets anders vermelden.
Gebruiker
Websites
Paginaweergaven
Lichtgewicht tracking
Paginaweergaven
Advanced tracking
Sessies
Advanced tracking
Events children
Advanced tracking
Uitgaande klikken
Advanced tracking / Lichtgewicht tracking
Sessie-opnames
Advanced tracking
Bezoekers
Advanced tracking
Saved views
Advanced tracking / Lichtgewicht tracking
Doelen
Advanced tracking / Lichtgewicht tracking
Goal conversions
Advanced tracking / Lichtgewicht tracking
Heatmaps
Advanced tracking
Annotations
Advanced tracking / Lichtgewicht tracking
Websitestatistieken
Advanced tracking / Lichtgewicht tracking
Eigen domeinen
Betaling en abonnementen - BasicWebstats account
Referred signups
Account logboeken