Mit der MEDIMACH-API haben Sie Zugriff auf die Daten der Analsyen über eine Webservice-Schnittstelle. So können Sie von einem anderen Programm aus auf diese Schnittstelle zugreifen und sich berechnete Daten zurückgeben lassen. Über die Schnittstelle sind dabei grundsätzlich alle Auswertungen möglich, die Sie auch direkt im Programm MEDIMACH erstellen können.
Dieser Key wird einfach bei jeder Anfrage an den Webservice mitgeschickt.
Das funktioniert auch im Browser, so dass ein Test der Anfragen sehr leicht möglich ist. Probieren Sie es aus – mit dem folgenden Link:
https://main.MEDIMACH-api.io/v1/analyses?access_token=1234567890
Mit diesem Befehl werden die im System zur Verfügung stehenden Analysen für den angegebenen API-Key angezeigt.
https://main.MEDIMACH-api.io/v1/analyses/0240033301/media?access_token=1234567890
Ausgegeben wird dabei eine Liste mit IDs und Namen. Die IDs werden dabei für den weiteren Zugriff auf die Medien benötigt.
https://main.MEDIMACH-api.io/v1/analyses/0240033301?access_token=1234567890
Zurück kommt folgende Information:
Beim Feld „n“ wird die Fallzahl ausgegeben, hier sind es 112.149 ungewichtete Fälle. Der Projektionsfaktor beträgt 504,91, damit kann man von der gewichteten Fallzahl die Hochrechnung ermitteln (Ausweis dann in Mio).
Danach kommt eine Auflistung der in der Analyse vorhandenen Zeiträume (wie durchschnittlicher Monat, Woche usw.)
Der einfachste Fall ist die Rückgabe der Daten für ein Medium. Rufen Sie als Beispiel den folgenden Link in der Live-Doku auf:
https://main.MEDIMACH-api.io/swagger-ui/#!/analyses/PostMedia_post_4
Bei der Analysen-ID können Sie die 0240033301 (für die internet facts 2013-01) verwenden. Und bei „media“ kann das folgende JSON eingesetzt werden:
Der Zeitraum („period“) wird hier auf den durchschnittlichen Monat (DM) gesetzt. Als Medium wird das Gesamtangebot von SPIEGEL Online aus (ID „AGOF_spiegel“) – natürlich können hier beliebige Medien-IDs eingesetzt werden. Und bei den „fields“ wird angegeben, welche Werte zurückgegeben werden sollen:
percent: Reichweite in Prozent
extrapolationMio: Reichweite Hochrechnung in Mio
contacsMio: Kontakte in Mio
Weitere Werte sind möglich.
Als Antwort kommt zurück:
Das Angebot hat also eine Reichweite von 16,3%, das entspricht 11,44 Mio Personen innerhalb der Grundgesamtheit. Diese Personen wiederum haben im durchschnittlichen Monat 606,91 Mio Kontakte.
Dieser Einstieg soll nur einen kleinen Einblick in die Möglichkeiten der MEDIMACH-API bieten. Für weitere Informationen stehen wir gern zur Verfügung.
Zugriffsschlüssel
Für den Zugriff auf den Webservice benötigen Sie einen API-Key, den Sie von uns erhalten. Über diesen Key wird insbesondere festgelegt, welche Wellen der internet facts Sie nutzen können.Dieser Key wird einfach bei jeder Anfrage an den Webservice mitgeschickt.
Funktionsweise
Der Zugriff ist sehr einfach: Sie erstellen eine Anfrage mit dem gewünschten Befehl und schicken diesen an den Webservice. Als Antwort erhalten Sie die Daten – meist im Format JSON.Das funktioniert auch im Browser, so dass ein Test der Anfragen sehr leicht möglich ist. Probieren Sie es aus – mit dem folgenden Link:
https://main.MEDIMACH-api.io/v1/analyses?access_token=1234567890
Mit diesem Befehl werden die im System zur Verfügung stehenden Analysen für den angegebenen API-Key angezeigt.
Grundsätzlicher Aufbau
Der Zugriff auf die MEDIMACH-API ist sehr leicht in den gängigen Programmiersprachen zu bewerkstelligen. Trotzdem ist es natürlich notwendig, die Struktur der Daten zu kennen.Analysen
Jede Welle der internet facts bezeichnen wir als Analyse. Welche Analysen verfügbar sind, können Sie über die API abrufen (siehe https://main.MEDIMACH-api.io/doc/api/analyses.api.html#available-analyses). Sie bekommen eine Liste mit IDs der Analysen. Bei allen weiteren Befehlen benötigen Sie diese Analysen-ID.Analyseninhalte
Jede Analyse beinhaltet Informationen zu Zielgruppen und Medien. Welche Zielgruppen und Medien in einer Analyse zur Verfügung stehen, kann natürlich ebenfalls über die API abgerufen werden. Hier ein Aufruf, der alle Medien in der AGOF internet facts 2013-01 anzeigt:https://main.MEDIMACH-api.io/v1/analyses/0240033301/media?access_token=1234567890
Ausgegeben wird dabei eine Liste mit IDs und Namen. Die IDs werden dabei für den weiteren Zugriff auf die Medien benötigt.
Analyseninformation
Zu einer Analyse können Informationen ausgegeben werden. Hier der entsprechende Befehl über die API:https://main.MEDIMACH-api.io/v1/analyses/0240033301?access_token=1234567890
Zurück kommt folgende Information:
{
"defaultProjection": 1000000,
"languages": [
"de",
"en"
],
"n": 112149,
"projectionFactor": 504.91,
"periods": [
{
"key": "DM",
"description": "Ø Monat (Nov, Dez, Jan 2013)"
},
...
Beim Feld „n“ wird die Fallzahl ausgegeben, hier sind es 112.149 ungewichtete Fälle. Der Projektionsfaktor beträgt 504,91, damit kann man von der gewichteten Fallzahl die Hochrechnung ermitteln (Ausweis dann in Mio).
Danach kommt eine Auflistung der in der Analyse vorhandenen Zeiträume (wie durchschnittlicher Monat, Woche usw.)
Einfache Auswertung
Mit den so ermittelten Inhalten der Analyse können jetzt Auswertungen durchgeführt werden.Der einfachste Fall ist die Rückgabe der Daten für ein Medium. Rufen Sie als Beispiel den folgenden Link in der Live-Doku auf:
https://main.MEDIMACH-api.io/swagger-ui/#!/analyses/PostMedia_post_4
Bei der Analysen-ID können Sie die 0240033301 (für die internet facts 2013-01) verwenden. Und bei „media“ kann das folgende JSON eingesetzt werden:
{
"period": "DM",
"media": [ "AGOF_spiegel"],
"fields": ["percent","extrapolationMio","contactsMio"]
}
Der Zeitraum („period“) wird hier auf den durchschnittlichen Monat (DM) gesetzt. Als Medium wird das Gesamtangebot von SPIEGEL Online aus (ID „AGOF_spiegel“) – natürlich können hier beliebige Medien-IDs eingesetzt werden. Und bei den „fields“ wird angegeben, welche Werte zurückgegeben werden sollen:
percent: Reichweite in Prozent
extrapolationMio: Reichweite Hochrechnung in Mio
contacsMio: Kontakte in Mio
Weitere Werte sind möglich.
Als Antwort kommt zurück:
[
{
"percent": 16.3,
"extrapolationMio": 11.44,
"contactsMio": 606.91,
"status": 0,
"key": "AGOF_spiegel"
}
]
Das Angebot hat also eine Reichweite von 16,3%, das entspricht 11,44 Mio Personen innerhalb der Grundgesamtheit. Diese Personen wiederum haben im durchschnittlichen Monat 606,91 Mio Kontakte.
Weitere Auswertungen
Natürlich sind viele weitere Auswertungen möglich – siehe die Dokumentation. Es können Zielgruppen gesetzt werden und ebenso Tarifangaben. Bis hin zu ganzen Plänen, für die dann die Werte zurückgegeben werden können.Dieser Einstieg soll nur einen kleinen Einblick in die Möglichkeiten der MEDIMACH-API bieten. Für weitere Informationen stehen wir gern zur Verfügung.