Einen Traffic-Report erstellen¶
Note
Im Body muss mindestens eines der Attribute domains oder vhosts definiert sein.
Senden einer POST-Anfrage an den Endpunkt /reports-v2.
Beschreibung¶
Mit der Create-Traffic-Report-Anfrage erstellen Sie einen neuen Traffic-Report.
Voraussetzungen¶
Werte der Anfrage: keine
Objekte: CreateReportVO
Anfrage¶
Um einen Traffic-Report zu erstellen, müssen dem Pfad der Anfrage keine weiteren Informationen hinzugefügt werden.
Für eine detaillierte Spezifikation, welche Informationen zum Erstellen eines Reports erforderlich sind, muss im Body das Objekt CreateReportVO mit den folgenden Attributen definiert werden:
| Attribut | Beschreibung | Werte |
|---|---|---|
fromDate |
Das Startdatum des Report-Zeitraums im ISO-8601-Format. | string($date) |
toDate |
Das Enddatum des Report-Zeitraums im ISO-8601-Format. | string($date) |
domains |
Ein Array von Domainnamen, die in den Traffic-Report aufgenommen werden sollen. Das System erweitert jede Domain bei der Erstellung um ihre Subdomains.HinweisUm eine Domain mit allen ihren Virtual Hosts aufzunehmen, muss das Attribut vhosts leer sein. |
array[string] |
vhosts |
Ein Array von Subdomainnamen, die in den Traffic-Report aufgenommen werden sollen.HinweisUm nur bestimmte Virtual Hosts aufzunehmen, kann das Attribut domains leer sein. |
array[string] |
language |
Die Sprache der Ausgabe des Traffic-Reports. |
|
name |
Der Name des Traffic-Reports. | string |
Die folgenden Attribute sind optional:
| Attribut | Beschreibung | Werte |
|---|---|---|
comment |
Ein Kommentar für den Traffic-Report. | string |
Das System gibt als Antwort das neue Report-Objekt mit den Informationen zum erstellten Eintrag zurück.
Beispiel¶
Beispiel-Request-Body:
{
"domains": [
"string"
],
"vhosts": [
"string"
],
"language": "string",
"fromDate": "string",
"toDate": "string",
"comment": "string",
"name": "string"
}
Antworten¶
Die folgenden Antworten sind möglich:
| STATUSCODE | BESCHREIBUNG |
|---|---|
| 201 | Die Anfrage war erfolgreich und ein neues Objekt wurde erstellt. |
| 400 | Die Anfrage war nicht erfolgreich. Die Anfrage war fehlerhaft oder es fehlen Informationen. |
| 401 | Die Anfrage war nicht erfolgreich, da die Authentifizierung fehlerhaft war. |
| 403 | Die Anfrage war nicht erfolgreich, da die erforderlichen Berechtigungen fehlen. |