PostHog · Schema

UsageMetric

A/B TestingAnalyticsFeature FlagsOpen SourceProduct AnalyticsSession Recording

Properties

Name	Type	Description
change_from_previous_pct	number
display	object
format	object
id	string
interval	integer
name	string
previous	number
timeseries	array	Daily values over the current interval period. Only populated when display is 'sparkline'.
timeseries_labels	array	ISO date strings for sparkline tooltip labels. Only populated when display is 'sparkline'.
value	number

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UsageMetric",
  "title": "UsageMetric",
  "additionalProperties": false,
  "properties": {
    "change_from_previous_pct": {
      "default": null,
      "title": "Change From Previous Pct",
      "type": "number",
      "nullable": true
    },
    "display": {
      "$ref": "#/components/schemas/UsageMetricDisplay"
    },
    "format": {
      "$ref": "#/components/schemas/UsageMetricFormat"
    },
    "id": {
      "title": "Id",
      "type": "string"
    },
    "interval": {
      "title": "Interval",
      "type": "integer"
    },
    "name": {
      "title": "Name",
      "type": "string"
    },
    "previous": {
      "title": "Previous",
      "type": "number"
    },
    "timeseries": {
      "default": null,
      "description": "Daily values over the current interval period. Only populated when display is 'sparkline'.",
      "title": "Timeseries",
      "items": {
        "type": "number"
      },
      "type": "array",
      "nullable": true
    },
    "timeseries_labels": {
      "default": null,
      "description": "ISO date strings for sparkline tooltip labels. Only populated when display is 'sparkline'.",
      "title": "Timeseries Labels",
      "items": {
        "type": "string"
      },
      "type": "array",
      "nullable": true
    },
    "value": {
      "title": "Value",
      "type": "number"
    }
  },
  "required": [
    "display",
    "format",
    "id",
    "interval",
    "name",
    "previous",
    "value"
  ],
  "type": "object"
}