addedInput schema / additionalProperties
Added value: +true
addedInput schema / properties / metric
Added value: +{
+ "description": "Only these metric names (see metricsAvailable), e.g. [\"retail_sales_by_region\"].",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+}
addedInput schema / properties / section
Added value: +{
+ "description": "Only metrics from this dashboard tab.",
+ "enum": [
+ "market_overview",
+ "license_activity"
+ ],
+ "type": "string"
+}
removedOutput schema / properties / marketLandscape / properties / licenseActivity
Removed value: -{
- "additionalProperties": true,
- "properties": {
- "activeLicenses": {
- "type": "number"
- },
- "cumulativeLicenseGrowth": {
- "items": {
- "additionalProperties": true,
- "properties": {
- "period": {
- "type": "string"
- },
- "value": {
- "type": "number"
- }
- },
- "required": [
- "period",
- "value"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "monthlyNewLicenses": {
- "items": {
- "additionalProperties": true,
- "properties": {
- "period": {
- "type": "string"
- },
- "value": {
- "type": "number"
- }
- },
- "required": [
- "period",
- "value"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "newLicensesYearToDate": {
- "type": "number"
- }
- },
- "type": "object"
-}
removedOutput schema / properties / marketLandscape / properties / marketOverview
Removed value: -{
- "additionalProperties": true,
- "properties": {
- "activeLicenses": {
- "type": "number"
- },
- "licenseTypeDistribution": {
- "items": {
- "additionalProperties": true,
- "properties": {
- "count": {
- "type": "number"
- },
- "licenseType": {
- "type": "string"
- }
- },
- "required": [
- "licenseType",
- "count"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "monthlyRetailSales": {
- "items": {
- "additionalProperties": true,
- "properties": {
- "period": {
- "type": "string"
- },
- "value": {
- "type": "number"
- }
- },
- "required": [
- "period",
- "value"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "overallAverageTestPassRate": {
- "type": "number"
- },
- "totalRetailSales": {
- "type": "number"
- }
- },
- "type": "object"
-}
addedOutput schema / properties / marketLandscape / properties / meta / properties / dateRange / description
Added value: +"The dashboard filter this snapshot was read under; YTD is the default."
addedOutput schema / properties / marketLandscape / properties / meta / properties / fetchedAt / description
Added value: +"When this snapshot was taken. The dashboard itself keeps no archive."
addedOutput schema / properties / marketLandscape / properties / metrics
Added value: +{
+ "items": {
+ "additionalProperties": true,
+ "properties": {
+ "derivedFrom": {
+ "description": "Present only when FindWeedNY computed this metric by dividing the listed series, because the dashboard did not return its own element that day.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "dimension": {
+ "description": "What each point’s category is: region | product_category | license_type. Absent on scalars and monthly series.",
+ "type": "string"
+ },
+ "metric": {
+ "type": "string"
+ },
+ "points": {
+ "items": {
+ "additionalProperties": true,
+ "properties": {
+ "category": {
+ "description": "The breakdown member. Present on breakdowns only — see dimension.",
+ "type": "string"
+ },
+ "period": {
+ "description": "ISO month start (YYYY-MM-01). Present on monthly series only.",
+ "type": "string"
+ },
+ "value": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "value"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "section": {
+ "description": "market_overview | license_activity — which dashboard tab published it",
+ "type": "string"
+ },
+ "title": {
+ "description": "The chart title as it appears on the dashboard",
+ "type": "string"
+ },
+ "unit": {
+ "description": "USD | licenses | units | transactions | tests | percent | USD per unit | USD per transaction",
+ "type": "string"
+ }
+ },
+ "required": [
+ "section",
+ "metric",
+ "title",
+ "unit",
+ "points"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+}
addedOutput schema / properties / marketLandscape / properties / metricsAvailable
Added value: +{
+ "description": "Every metric in the snapshot, including any filtered out of this response. Call again with `metric` to fetch one.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+}
addedOutput schema / properties / marketLandscape / properties / summary
Added value: +{
+ "additionalProperties": true,
+ "description": "The four headline numbers, so simple questions do not need the metrics array.",
+ "properties": {
+ "activeLicenses": {
+ "type": "number"
+ },
+ "newLicensesYearToDate": {
+ "type": "number"
+ },
+ "overallAverageTestPassRate": {
+ "description": "Percent, 0-100.",
+ "type": "number"
+ },
+ "totalRetailSales": {
+ "description": "Year-to-date retail sales in USD, at full precision.",
+ "type": "number"
+ }
+ },
+ "type": "object"
+}