contentstack · Schema

AnalyticsRequest

Common parameters for analytics data requests.

Properties

Name	Type	Description
from	string	Start date for the analytics query in YYYY-MM-DD format. Maximum range is 90 days.
to	string	End date for the analytics query in YYYY-MM-DD format.
duration	string	Aggregation duration for time series data.
skip	integer	Number of records to skip for pagination.
limit	integer	Maximum number of records to return.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AnalyticsRequest",
  "title": "AnalyticsRequest",
  "type": "object",
  "description": "Common parameters for analytics data requests.",
  "properties": {
    "from": {
      "type": "string",
      "format": "date",
      "description": "Start date for the analytics query in YYYY-MM-DD format. Maximum range is 90 days."
    },
    "to": {
      "type": "string",
      "format": "date",
      "description": "End date for the analytics query in YYYY-MM-DD format."
    },
    "duration": {
      "type": "string",
      "description": "Aggregation duration for time series data.",
      "enum": [
        "day",
        "week",
        "month"
      ]
    },
    "skip": {
      "type": "integer",
      "description": "Number of records to skip for pagination.",
      "minimum": 0,
      "default": 0
    },
    "limit": {
      "type": "integer",
      "description": "Maximum number of records to return.",
      "minimum": 1,
      "maximum": 1000,
      "default": 100
    }
  }
}