AnalyticsSeriesDefinitionDto

Endpoints · All schemas

Field	Required	Description
available	Yes	Whether this report carries the series for the selected scope
collected	Yes	Written by the local nightly collector rather than read live
estimate	Yes	An estimate, never a charge
grain	Yes	See definition below
id	Yes	See definition below
measurementScope	Yes	See definition below
owner	Yes	See definition below
scopes	Yes	Selections the series can be read for
source	Yes	Where the number comes from
unit	Yes	See definition below

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: AnalyticsGrain, AnalyticsSeriesId, AnalyticsMeasurementScope, AnalyticsSeriesOwner, AnalyticsScopeKind, AnalyticsUnit

{
  "properties": {
    "available": {
      "description": "Whether this report carries the series for the selected scope",
      "type": "boolean"
    },
    "collected": {
      "description": "Written by the local nightly collector rather than read live",
      "type": "boolean"
    },
    "estimate": {
      "description": "An estimate, never a charge",
      "type": "boolean"
    },
    "grain": {
      "$ref": "#/components/schemas/AnalyticsGrain"
    },
    "id": {
      "$ref": "#/components/schemas/AnalyticsSeriesId"
    },
    "measurementScope": {
      "$ref": "#/components/schemas/AnalyticsMeasurementScope"
    },
    "owner": {
      "$ref": "#/components/schemas/AnalyticsSeriesOwner"
    },
    "scopes": {
      "description": "Selections the series can be read for",
      "items": {
        "$ref": "#/components/schemas/AnalyticsScopeKind"
      },
      "type": "array"
    },
    "source": {
      "description": "Where the number comes from",
      "type": "string"
    },
    "unit": {
      "$ref": "#/components/schemas/AnalyticsUnit"
    }
  },
  "required": [
    "available",
    "collected",
    "estimate",
    "grain",
    "id",
    "measurementScope",
    "owner",
    "scopes",
    "source",
    "unit"
  ],
  "type": "object"
}