Die Base-URL der API ist https://api.getklar.com/.

Rate Limit

Die API erzwingt ein Rate Limit: 2 Anfragen pro 30 Sekunden.

Du kannst die Daten für maximal 31 Tage auf einmal abrufen.

1. Access Token abrufen

Hole dir im Frontend den Refresh Token unter Store-Konfigurator / Store Settings. Ein Refresh Token ist mit einem Store und einem User verknüpft.

Dieser Endpunkt wird verwendet, um den statischen Refresh Token eines Users gegen einen temporären Access Token einzutauschen, der für die API-Authentifizierung benötigt wird.

Detail	Beschreibung
Endpoint	POST /public/auth/token
Beschreibung	Liefert einen kurzlebigen Access Token für die API-Authentifizierung.

Request

Header	Beschreibung
token	Der statische Refresh Token des Users.

Erfolgreiche Antwort: 201 Created

Der Response-Body enthält den temporären Access Token und dessen Ablaufzeit in Millisekunden.

Wichtiger Hinweis: Der accessToken ist 5 Minuten gültig (300.000 Millisekunden). Der User muss nach Ablauf einen neuen anfordern.

{
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expiresIn": 300000 // Milliseconds
}

2. Attribution Report abrufen

Dieser Endpunkt ruft die Daten des Attribution Reports basierend auf den angegebenen Filtern ab.

Detail	Beschreibung
Endpoint	GET /public/attribution

Authentifizierung

Dieser Endpunkt erfordert einen Bearer Token im Authorization-Header.

Header	Wert-Format
Authorization	Bearer <accessToken> (wobei <accessToken> der im Schritt Access Token abrufen erhaltene Token ist).

Query-Parameter

Parameter	Typ	Erforderlich	Beschreibung	Zulässige Werte / Format
startDate	string	Ja	Das Startdatum für den Report.	Format: yyyy-mm-dd. Beispiel: 2025-01-01
endDate	string	Ja	Das Enddatum für den Report. Muss innerhalb von 31 Tagen ab dem startDate liegen. Das endDate wird immer ausgeschlossen.	Format: yyyy-mm-dd. Beispiel: 2025-01-31
metric	string	Nein	Das für die Berechnung zu verwendende Attributionsmodell.	first_touch, last_touch, data_driven, linear, any_click, any_click_unique, u_shape, time_decay, marketing_mix
window	string	Nein	Das zu berücksichtigende Attributionsfenster.	unlimited, 1_day, 7_day, 28_day
date_breakdown	string	Nein	Der Datumstyp, nach dem die Ergebnisse gruppiert werden.	order, touch

Erfolgreiche Antwort: 200 OK

Die Antwort ist ein Array von Objekten, wobei jedes Objekt die angeforderten Dimensionen und Metriken enthält.

JSON

[
  {
        "channelName": "Google Generic Paid Search",
        "date": "2025-10-02",
        "campaignName": "Sample",
        "campaignId": 123,
        "adGroupName": "Catch all",
        "adGroupId": 123,
        "adName": "Sample",
        "adId": 123,
        "orders": 2.1329447083,
        "nc": 1.299611375,
        "rc": 0.8333333333,
        "netRevenue": 126.8840278483,
        "grossRevenue": 136.5776026566,
        "cost": 2.2488128275,
        "clicks": 105,
        "impressions": 1527,
        "cm1": 82.8780053944,
        "cm2": 72.1865404057,
        "clv_30": 44.346015638,
        "clv_60": 44.346015638,
        "clv_90": 44.346015638,
        "acm2": 44.346015638,
        "ncGrossRevenue": 82.0942693233,
        "rcGrossRevenue": 54.4833333333,
        "ncNetRevenue": 75.9650247472,
        "rcNetRevenue": 50.9190031011
    },
  {
    "channelName": "Organic Social",
    "date": "2025-01-15",
    "campaignName": "Jan Content Push",
    "campaignId": "cmp_67890",
    ...
  }

]

Attribution-API-Dokumentation