API Documentation

This is the documentation for the available API endpoints, which are built around the REST architecture. All the API endpoints will return a JSON response with the standard HTTP response codes and need a Bearer Authentication via an API Key.

Get your own API Key

Base URL

Authentication

All the API endpoints require an API key sent by the Bearer Authentication method.

Authorization: Bearer {api_key}

Example

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.

Example

{
    "errors": [
        {
            "title": "You do not have access to the API.",
            "status": 401
        }
    ]
}

Status codes

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 resultaten van API-eindpunten gebruiken de UTC tijdzone tenzij anders is aangegeven.

User

Websites

Paginaweergaven

Bezoekers

Doelen

Goal conversions

Annotations

Website statistics

Aangepaste domeinen

Betaling en abonnementen - BasicWebstats account

Account logboeken