Kostenlos registrieren

Ryte API

Der vollständige Integration Guide.

Die Ryte API bietet die einzigartige Möglichkeit Reportdaten aus dem Modul “Website Success” direkt anzuzeigen, Daten zu exportieren und in die eigenen Applikationen oder Tools zu implementieren. Ziehe Dir die notwendigen Reportdaten ganz einfach aus unserer API heraus und benutze diese automatisiert, auch ohne das Ryte Benutzer-Interface.

Ryte API bietet

Ryte API bietet

  • automatisierten Zugriff auf Daten aus Ryte Reports
  • Integration von Ryte in Deine Business Lösungen
  • Extraktion von intelligenten Metriken aus den Modulen Zoom und Keywords
Vorteile der Ryte API Nutzung

Vorteile der Ryte API Nutzung

  • gefilterte, aggregierte oder unbearbeitete Daten extrahieren
  • direkt in Deine Workflows integrierbar
  • Abruf von Daten aus Graphen, Übersichten und Listen

Was muss Du tun, um Ryte API benutzen zu können?

Wenn Du Ryte Daten für Deine eigenen Zwecke nutzen möchtest, benötigst Du einen Account bei Ryte (ab dem Business Paket). Den Zugangsschlüssel (API-Key) bekommst Du automatisch mit dem gebuchten Account. Du kannst also jederzeit auf die API zugreifen und musst nichts gesondert beantragen. Welche Daten aus dem Report genau abgerufen werden, entscheidest Du selbst.

Authentifizierung

Die Authentifizierung erfolgt über einen speziellen API Key. Wenn Du im jeweiligen Report in den Modulen Zoom oder Keywords den entsprechenden API Call kopierst, ist der Authentifizierungsschlüssel bereits dort enthalten. Mit dem API Key kannst Du dann auf die Ryte API Services zugreifen.

Ausgabeformat

Als Format kann über die URL-Route JSON (Standard) sowie XML und CSV verwendet werden. Als Encoding der API wird immer UTF-8 als Zeichensatz verwendet.

So erhältst Du den benötigten API Call:

Step 1

Wähle den Report aus, woraus Du die Daten extrahieren möchtest.

API CallGehe oben rechts auf das Zahnrad und wähle im Dropdown Menü “API Call” aus.

Step 1

Step 2

Dein API Key wird automatisch generiert und anschließend im API Call Fenster angezeigt.

Nur noch den Code kopieren.
Fast fertig.

Step 2

Step 3

Sende den Query als Body im HTTP Post Request an unseren API Endpoint (z.B. https://api.ryte.com/zoom/json).
Dieser Beispiel Code zeigt Dir, wie ein Endpoint aussehen könnte. Für dieses Beispiel haben wir ein einfaches CURL Beispiel in PHP verwendet.

<?php

/**********************************************************************
* CURL-less Example to get Status Code Data from Ryte API
**********************************************************************/

/***
* Ryte API Endpoint and Zoom Route
***/

$apiEndpoint = 'https://api.ryte.com';
$zoomRoute = '/zoom/json';

$requestUrl = $apiEndpoint . $zoomRoute;


/***
* JSON Request copied from Ryte Interface
* This example will retrieve the Status Code Overview of the project
* (Number of 2xx, 3xx,301,302,4xx,5xx)
* Tipp: Use the Zoom Interface to "click + play" the data you need, afterwards copy the API call and insert it here.
***/

$postBody = '{ "action": "aggregate",
"authentication": {
"api_key": "[your api key]",
"project": "[your project slug or project id]"
},
"pagination": {
"limit": 100,
"offset": 0
},
"group": [
"header_status_group"
],
"functions": [
{
"name": "count",
"method": "count",
"parameters": [
{
"attribute": "url"
}
]
}
],
"filter": {
"AND": [
{
"field": "is_local",
"operator": "==",
"value": true
}
]
}
}';

$options = array(
'http' => array(
'header' => 'Content-Type: text/json',
'method' => 'POST',
'content' => $postBody,
),
);

$context = stream_context_create($options);

$result = file_get_contents($requestUrl, false, $context);

/***
* Handle HTTP error
***/

if ($result === FALSE) {

echo "Something went wrong";

} else {

/***
* Print Result
***/
echo "Result:\n";
$jsonResult = json_decode($result, true);
print_r($jsonResult);

}
Download

Beispiel der Format-Routen für Website Success Reports:
https://api.ryte.com/zoom/json
https://api.ryte.com/zoom/xml
https://api.ryte.com/zoom/csv

Hast Du noch Fragen zur Ryte API?

Dann kontaktiere uns jederzeit via E-Mail unter business@ryte.com oder Telefon 089-4161151-20.

RYTE Kostenlos registrieren