getAccountVisitorStatistics

GET /v1/accounts/{accountIdentifier}/stats/visitors/

API version

v1

Request method

GET

Operation ID

getAccountVisitorStatistics

---

Liefert Statistiken zu Besucherzahlen eines Projekts

Request

• accountIdentifierstring

  required

  Name oder ID eines Accounts

Responses

Format

application/json

Description

Objekt der Visitor-Statistics

Schema documentation

• idstring

  ID des Projekts

• last_information_atnumber
• limitobject
  • articleobject

    required
    • namestring

      required
    • numbernumber

      required
  • maximumnumber

    required

    Vorgesehene monatliche Besucherzahl

  • maximum_updated_atstring (date-time)

    Zeitpunkt der letzten Veränderung der monatlichen Besucherzahl

  • usagenumber

    required

    Relative Auslastung (0 bis 1) der vorgesehen monatlichen Besucherzahl

  • usage_absolutenumber (integer)

    required

    Absolute Anzahl der bisherigen monatlichen Besucher

• namestring

  Name des Projekts

• skip_informationboolean
• throttlingobject
  • enabledboolean

    required
• grace_periodobject
• visitor_informationobject
  • dailyarray of object
    • Array[
    • *object
      • countnumber (integer)
      • datestring (date-time)
    ]
• monthlyarray of object
  • Array[
  • *object
    • countnumber (integer)
    • datestring (date-time)
  ]

Example

{
  "id": "string",
  "last_information_at": 123,
  "limit": {
    "article": {
      "name": "string",
      "number": 123
    },
    "maximum": 123,
    "maximum_updated_at": "2024-09-16T00:26:33.046Z",
    "usage": 123,
    "usage_absolute": 123
  },
  "name": "string",
  "skip_information": true,
  "throttling": {
    "enabled": true
  },
  "grace_period": {},
  "visitor_information": {
    "daily": [
      {
        "count": 123,
        "date": "2024-09-16T00:26:33.046Z"
      }
    ],
    "monthly": [
      {
        "count": 123,
        "date": "2024-09-16T00:26:33.046Z"
      }
    ]
  }
}

JSON Schema

{
  "title": "VisitorStatistics",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "ID des Projekts"
    },
    "last_information_at": {
      "type": "number"
    },
    "limit": {
      "required": [
        "article",
        "maximum",
        "usage",
        "usage_absolute"
      ],
      "type": "object",
      "properties": {
        "article": {
          "required": [
            "name",
            "number"
          ],
          "type": "object",
          "properties": {
            "name": {
              "type": "string"
            },
            "number": {
              "type": "number"
            }
          }
        },
        "maximum": {
          "type": "number",
          "description": "Vorgesehene monatliche Besucherzahl"
        },
        "maximum_updated_at": {
          "type": "string",
          "description": "Zeitpunkt der letzten Veränderung der monatlichen Besucherzahl",
          "format": "date-time"
        },
        "usage": {
          "type": "number",
          "description": "Relative Auslastung (0 bis 1) der vorgesehen monatlichen Besucherzahl"
        },
        "usage_absolute": {
          "type": "number",
          "description": "Absolute Anzahl der bisherigen monatlichen Besucher",
          "format": "integer"
        }
      }
    },
    "name": {
      "type": "string",
      "description": "Name des Projekts"
    },
    "skip_information": {
      "type": "boolean"
    },
    "throttling": {
      "required": [
        "enabled"
      ],
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean"
        }
      }
    },
    "grace_period": {
      "type": "object"
    },
    "visitor_information": {
      "type": "object",
      "properties": {
        "daily": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "count": {
                "type": "number",
                "format": "integer"
              },
              "date": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "monthly": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "count": {
                "type": "number",
                "format": "integer"
              },
              "date": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        }
      }
    }
  }
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v1/accounts/string/stats/visitors