getAnalyticsMetadata

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/postman/main/json-schema/postman-get-analytics-metadata-schema.json",
  "title": "getAnalyticsMetadata",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/postman-analytics-api-openapi.yml#/components/schemas/getAnalyticsMetadata",
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/$defs/GetAnalyticsMetadataData",
      "description": "The Analytics API's metadata information."
    }
  },
  "$defs": {
    "GetAnalyticsDataColumnsDataItems": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the column."
        },
        "type": {
          "$ref": "#/$defs/GetAnalyticsDataColumnsDataItemsType",
          "description": "The data type of the column."
        },
        "format": {
          "type": "string",
          "description": "The data type's format."
        },
        "description": {
          "type": "string",
          "description": "A description of what the column represents."
        }
      },
      "title": "GetAnalyticsDataColumnsDataItems"
    },
    "GetAnalyticsDataColumnsDataItemsType": {
      "type": "string",
      "enum": [
        "DATE",
        "STRING",
        "INTEGER",
        "TIMESTAMP",
        "BOOLEAN",
        "NUMBER",
        "FLOAT"
      ],
      "description": "The data type of the column.",
      "title": "GetAnalyticsDataColumnsDataItemsType"
    },
    "GetAnalyticsMetadataData": {
      "type": "object",
      "properties": {
        "description": {
          "type": "string",
          "description": "A description of the endpoint."
        },
        "resources": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/GetAnalyticsMetadataDataResourcesItems"
          },
          "description": "A list of accepted resource values."
        }
      },
      "description": "The Analytics API's metadata information.",
      "title": "GetAnalyticsMetadataData"
    },
    "GetAnalyticsMetadataDataResourcesItems": {
      "oneOf": [
        {
          "$ref": "#/$defs/getAnalyticsMetadataResourceData"
        },
        {
          "$ref": "#/$defs/getAnalyticsMetadataParametersResponseData"
        }
      ],
      "title": "GetAnalyticsMetadataDataResourcesItems"
    },
    "GetAnalyticsMetadataResourceMetricsDataDetailedDataSchema": {
      "type": "object",
      "properties": {
        "columns": {
          "$ref": "#/$defs/getAnalyticsDataColumnsData"
        }
      },
      "description": "The response schema for the `detailed` view.",
      "title": "GetAnalyticsMetadataResourceMetricsDataDetailedDataSchema"
    },
    "GetAnalyticsMetadataResourceMetricsDataDetailedParametersFilters1": {
      "type": "object",
      "properties": {
        "workspace_type": {
          "$ref": "#/$defs/getAnalyticsMetadataResourceMetricsDataDetailedParametersFiltersData"
        },
        "duration": {
          "$ref": "#/$defs/getAnalyticsMetadataResourceMetricsDataDetailedParametersFiltersData"
        }
      },
      "description": "Information about the filter parameters.",
      "title": "GetAnalyticsMetadataResourceMetricsDataDetailedParametersFilters1"
    },
    "GetAnalyticsMetadataResourceMetricsDataSummaryDataSchema": {
      "type": "object",
      "properties": {
        "columns": {
          "$ref": "#/$defs/getAnalyticsDataColumnsData"
        }
      },
      "description": "The response schema for the `summary` view.",
      "title": "GetAnalyticsMetadataResourceMetricsDataSummaryDataSchema"
    },
    "getAnalticsMetadataPaginationData": {
      "type": "object",
      "properties": {
        "supported": {
          "type": "boolean",
          "description": "If true, pagination is supported for this metric."
        },
        "allowed_values": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "A list of the supported pagination parameters."
        }
      },
      "description": "Information about the metric's pagination parameters.",
      "title": "getAnalticsMetadataPaginationData"
    },
    "getAnalyticsDataColumnsData": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/GetAnalyticsDataColumnsDataItems"
      },
      "description": "A list of column entries.",
      "title": "getAnalyticsDataColumnsData"
    },
    "getAnalyticsMetadataParametersResponseData": {
      "type": "object",
      "properties": {
        "resource": {
          "type": "string",
          "description": "The name of the resource."
        },
        "description": {
          "type": "string",
          "description": "A description of the resource."
        },
        "type": {
          "type": "string",
          "description": "The metric's data type."
        },
        "isRequired": {
          "type": "boolean",
          "description": "If true, the metric is required."
        },
        "metrics": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/getAnalyticsMetadataResourceMetricsDataDetailed"
          },
          "description": "A list of the resource's detailed accepted metrics values."
        }
      },
      "description": "Detailed information about the resource including its metrics, parameters, and response schema.",
      "title": "getAnalyticsMetadataParametersResponseData"
    },
    "getAnalyticsMetadataResourceData": {
      "type": "object",
      "properties": {
        "resource": {
          "type": "string",
          "description": "The name of the resource."
        },
        "description": {
          "type": "string",
          "description": "A description of the resource."
        },
        "metrics": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/getAnalyticsMetadataResourceMetricsData"
          },
          "description": "A list of the resource's accepted metrics values."
        }
      },
      "description": "Information about the resource.",
      "title": "getAnalyticsMetadataResourceData"
    },
    "getAnalyticsMetadataResourceMetricsData": {
      "type": "object",
      "properties": {
        "metric": {
          "type": "string",
          "description": "The metric's name."
        },
        "description": {
          "type": "string",
          "description": "A description of the metric."
        }
      },
      "description": "Information about the resource's metric.",
      "title": "getAnalyticsMetadataResourceMetricsData"
    },
    "getAnalyticsMetadataResourceMetricsDataDetailed": {
      "type": "object",
      "properties": {
        "metric": {
          "type": "string",
          "description": "The metric's name."
        },
        "description": {
          "type": "string",
          "description": "A description of the metric."
        },
        "type": {
          "type": "string",
          "description": "The metric's data type."
        },
        "isRequired": {
          "type": "boolean",
          "description": "If true, the metric is required."
        },
        "parameters": {
          "$ref": "#/$defs/getAnalyticsMetadataResourceMetricsDataDetailedParameters"
        },
        "response": {
          "$ref": "#/$defs/getAnalyticsMetadataResourceMetricsDataDetailedResponse"
        }
      },
      "description": "Information about the resource's metric.",
      "title": "getAnalyticsMetadataResourceMetricsDataDetailed"
    },
    "getAnalyticsMetadataResourceMetricsDataDetailedData": {
      "type": "object",
      "properties": {
        "schema": {
          "$ref": "#/$defs/GetAnalyticsMetadataResourceMetricsDataDetailedDataSchema",
          "description": "The response schema for the `detailed` view."
        }
      },
      "description": "Information about the metric's `detailed` parameter.",
      "title": "getAnalyticsMetadataResourceMetricsDataDetailedData"
    },
    "getAnalyticsMetadataResourceMetricsDataDetailedParameters": {
      "type": "object",
      "properties": {
        "view": {
          "$ref": "#/$defs/getAnalyticsMetadataResourceMetricsDataDetailedParametersView"
        },
        "filters": {
          "$ref": "#/$defs/getAnalyticsMetadataResourceMetricsDataDetailedParametersFilters"
        },
        "pagination": {
          "$ref": "#/$defs/getAnalticsMetadataPaginationData"
        }
      },
      "description": "Information about the metric's parameters.",
      "title": "getAnalyticsMetadataResourceMetricsDataDetailedParameters"
    },
    "getAnalyticsMetadataResourceMetricsDataDetailedParametersFilters": {
      "oneOf": [
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        {
          "$ref": "#/$defs/GetAnalyticsMetadataResourceMetricsDataDetailedParametersFilters1"
        }
      ],
      "title": "getAnalyticsMetadataResourceMetricsDataDetailedParametersFilters"
    },
    "getAnalyticsMetadataResourceMetricsDataDetailedParametersFiltersData": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "The parameter's type."
        },
        "isRequired": {
          "type": "boolean",
          "description": "If true, the parameter is required."
        },
        "allowed_values": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "A list of the parameter's accepted values."
        }
      },
      "description": "Information about the filter.",
      "title": "getAnalyticsMetadataResourceMetricsDataDetailedParametersFiltersData"
    },
    "getAnalyticsMetadataResourceMetricsDataDetailedParametersView": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "The parameter's type."
        },
        "isRequired": {
          "type": "boolean",
          "description": "If true, the parameter is required."
        },
        "allowed_values": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "A list of the parameter's accepted values."
        },
        "description": {
          "type": "string",
          "description": "The parameter's description."
        }
      },
      "description": "Information about the `view` parameter.",
      "title": "getAnalyticsMetadataResourceMetricsDataDetailedParametersView"
    },
    "getAnalyticsMetadataResourceMetricsDataDetailedResponse": {
      "type": "object",
      "properties": {
        "detailed": {
          "$ref": "#/$defs/getAnalyticsMetadataResourceMetricsDataDetailedData"
        },
        "summary": {
          "$ref": "#/$defs/getAnalyticsMetadataResourceMetricsDataSummaryData"
        }
      },
      "description": "Information about the metric's `response` parameters.",
      "title": "getAnalyticsMetadataResourceMetricsDataDetailedResponse"
    },
    "getAnalyticsMetadataResourceMetricsDataSummaryData": {
      "type": "object",
      "properties": {
        "schema": {
          "$ref": "#/$defs/GetAnalyticsMetadataResourceMetricsDataSummaryDataSchema",
          "description": "The response schema for the `summary` view."
        }
      },
      "description": "Information about the metric's `summary` parameter.",
      "title": "getAnalyticsMetadataResourceMetricsDataSummaryData"
    }
  }
}