components: schemas: Channel: properties: groupId: format: int64 type: integer name: type: string ConnectionInfo: properties: admin: type: boolean connectedToAnalyticsCloud: type: boolean connectedToSpace: type: boolean siteSyncedToAnalyticsCloud: type: boolean ExpiredAsset: properties: href: type: string title: type: string usages: type: number Histogram: properties: metricName: type: string metrics: items: $ref: "#/components/schemas/Metric" type: array total: format: double type: number totalValue: format: double type: number InventoryAnalysis: properties: inventoryAnalysisItems: items: $ref: "#/components/schemas/InventoryAnalysisItem" type: array inventoryAnalysisItemsCount: format: int64 type: integer totalCount: format: int64 type: integer InventoryAnalysisItem: properties: count: format: int64 type: integer key: type: string title: type: string Metric: properties: metricType: type: string previousValue: format: double type: number previousValueKey: type: string trend: $ref: "#/components/schemas/Trend" value: format: double type: number valueKey: type: string ObjectEntryAcquisitionChannel: properties: name: type: string percentage: format: double type: number value: format: double type: number ObjectEntryHistogramMetric: properties: histograms: items: $ref: "#/components/schemas/Histogram" type: array ObjectEntryMetric: properties: dataSourceId: type: string defaultMetric: $ref: "#/components/schemas/Metric" externalReferenceCode: type: string selectedMetrics: items: $ref: "#/components/schemas/Metric" type: array ObjectEntryTopPages: properties: topPages: items: $ref: "#/components/schemas/TopPage" type: array totalCount: format: int64 type: integer Overview: properties: categoriesCount: format: int64 type: integer tagsCount: format: int64 type: integer totalCount: format: int64 type: integer trend: $ref: "#/components/schemas/Trend" vocabulariesCount: format: int64 type: integer PerformanceAssetConsumption: properties: performanceAssetConsumptionItems: items: $ref: "#/components/schemas/PerformanceAssetConsumptionItem" type: array performanceAssetConsumptionItemsCount: format: int64 type: integer totalCount: format: int64 type: integer PerformanceAssetConsumptionItem: properties: count: format: int64 type: integer key: type: string title: type: string PerformanceHistogramMetric: properties: histograms: items: $ref: "#/components/schemas/Histogram" type: array PerformanceMetric: properties: metricType: type: string metrics: items: $ref: "#/components/schemas/Metric" type: array PerformanceOverviewMetric: properties: downloadsMetric: $ref: "#/components/schemas/Metric" impressionsMetric: $ref: "#/components/schemas/Metric" readsMetric: $ref: "#/components/schemas/Metric" viewsMetric: $ref: "#/components/schemas/Metric" PerformanceTopAsset: properties: className: type: string downloads: format: double type: number embedded: type: object engagement: format: double type: number externalReferenceCode: type: string impressions: format: double type: number title: type: string trend: $ref: "#/components/schemas/Trend" type: type: string views: format: double type: number TopPage: properties: canonicalUrl: type: string defaultMetric: $ref: "#/components/schemas/Metric" pageTitle: type: string siteName: type: string Trend: properties: classification: enum: [NEGATIVE, NEUTRAL, POSITIVE] type: string percentage: format: double type: number info: license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html title: "" version: v1.0 openapi: 3.0.1 paths: "/channels": get: operationId: getChannelsPage parameters: - in: query name: keywords schema: type: string responses: 200: content: application/json: schema: items: $ref: "#/components/schemas/Channel" type: array application/xml: schema: items: $ref: "#/components/schemas/Channel" type: array tags: ["Channel"] "/connection-info": get: operationId: getConnectionInfo parameters: - in: query name: depotEntryGroupId required: true schema: format: int64 type: integer responses: 200: content: application/json: schema: $ref: "#/components/schemas/ConnectionInfo" application/xml: schema: $ref: "#/components/schemas/ConnectionInfo" tags: ["ConnectionInfo"] "/content-overview": get: operationId: getContentOverview parameters: - in: query name: depotEntryId schema: format: int64 type: integer - in: query name: languageId schema: type: string - in: query name: rangeEnd schema: type: string - in: query name: rangeKey schema: type: integer - in: query name: rangeStart schema: type: string responses: 200: content: application/json: schema: $ref: "#/components/schemas/Overview" application/xml: schema: $ref: "#/components/schemas/Overview" tags: ["Overview"] "/expired-assets": get: operationId: getExpiredAssetsPage parameters: - in: query name: depotEntryId schema: format: int64 type: integer - in: query name: languageId schema: type: string - in: query name: page schema: type: integer - in: query name: pageSize schema: type: integer responses: 200: content: application/json: schema: items: $ref: "#/components/schemas/ExpiredAsset" type: array application/xml: schema: items: $ref: "#/components/schemas/ExpiredAsset" type: array tags: ["ExpiredAsset"] "/file-overview": get: operationId: getFileOverview parameters: - in: query name: depotEntryId schema: format: int64 type: integer - in: query name: languageId schema: type: string - in: query name: rangeEnd schema: type: string - in: query name: rangeKey schema: type: integer - in: query name: rangeStart schema: type: string responses: 200: content: application/json: schema: $ref: "#/components/schemas/Overview" application/xml: schema: $ref: "#/components/schemas/Overview" tags: ["Overview"] "/inventory-analysis": get: operationId: getInventoryAnalysis parameters: - in: query name: categoryId schema: format: int64 type: integer - in: query name: depotEntryId schema: format: int64 type: integer - in: query name: groupBy schema: type: string - in: query name: languageId schema: type: string - in: query name: page schema: type: integer - in: query name: pageSize schema: type: integer - in: query name: rangeEnd schema: type: string - in: query name: rangeKey schema: type: integer - in: query name: rangeStart schema: type: string - in: query name: structureId schema: format: int64 type: integer - in: query name: tagId schema: format: int64 type: integer - in: query name: vocabularyId schema: format: int64 type: integer responses: 200: content: application/json: schema: $ref: "#/components/schemas/InventoryAnalysis" application/xml: schema: $ref: "#/components/schemas/InventoryAnalysis" tags: ["InventoryAnalysis"] "/object-entry-acquisition-channels": get: operationId: getObjectEntryAcquisitionChannelsPage parameters: - in: query name: groupId schema: format: int64 type: integer - in: query name: objectEntryId required: true schema: format: int64 type: integer - in: query name: rangeKey schema: type: integer responses: 200: content: application/json: schema: items: $ref: "#/components/schemas/ObjectEntryAcquisitionChannel" type: array application/xml: schema: items: $ref: "#/components/schemas/ObjectEntryAcquisitionChannel" type: array tags: ["ObjectEntryAcquisitionChannel"] "/object-entry-histogram-metric": get: operationId: getObjectEntryHistogramMetric parameters: - in: query name: groupId schema: format: int64 type: integer - in: query name: objectEntryId required: true schema: format: int64 type: integer - in: query name: rangeKey schema: type: integer - in: query name: selectedMetrics schema: items: type: string type: array responses: 200: content: application/json: schema: $ref: "#/components/schemas/ObjectEntryHistogramMetric" application/xml: schema: $ref: "#/components/schemas/ObjectEntryHistogramMetric" tags: ["ObjectEntryHistogramMetric"] "/object-entry-metric": get: operationId: getObjectEntryMetric parameters: - in: query name: groupId schema: format: int64 type: integer - in: query name: objectEntryId required: true schema: format: int64 type: integer - in: query name: rangeKey schema: type: integer - in: query name: selectedMetrics schema: items: type: string type: array responses: 200: content: application/json: schema: $ref: "#/components/schemas/ObjectEntryMetric" application/xml: schema: $ref: "#/components/schemas/ObjectEntryMetric" tags: ["ObjectEntryMetric"] "/object-entry-top-pages": get: operationId: getObjectEntryTopPages parameters: - in: query name: groupId schema: format: int64 type: integer - in: query name: objectEntryId required: true schema: format: int64 type: integer - in: query name: rangeKey schema: type: integer responses: 200: content: application/json: schema: $ref: "#/components/schemas/ObjectEntryTopPages" application/xml: schema: $ref: "#/components/schemas/ObjectEntryTopPages" tags: ["ObjectEntryTopPages"] "/performance-asset-consumption": get: operationId: getPerformanceAssetConsumption parameters: - in: query name: categoryId schema: format: int64 type: integer - in: query name: cmpProjectIds schema: items: format: int64 type: integer type: array - in: query name: depotEntryIds schema: items: format: int64 type: integer type: array - in: query name: groupBy schema: type: string - in: query name: page schema: type: integer - in: query name: pageSize schema: type: integer - in: query name: rangeKey schema: type: integer - in: query name: structureId schema: format: int64 type: integer - in: query name: tagId schema: format: int64 type: integer - in: query name: vocabularyId schema: format: int64 type: integer responses: 200: content: application/json: schema: $ref: "#/components/schemas/PerformanceAssetConsumption" application/xml: schema: $ref: "#/components/schemas/PerformanceAssetConsumption" tags: ["PerformanceAssetConsumption"] "/performance-histogram-metric": get: operationId: getPerformanceHistogramMetric parameters: - in: query name: cmpProjectIds schema: items: format: int64 type: integer type: array - in: query name: depotEntryIds schema: items: format: int64 type: integer type: array - in: query name: rangeKey schema: type: integer - in: query name: selectedMetric schema: type: string responses: 200: content: application/json: schema: $ref: "#/components/schemas/PerformanceHistogramMetric" application/xml: schema: $ref: "#/components/schemas/PerformanceHistogramMetric" tags: ["PerformanceHistogramMetric"] "/performance-metric": get: operationId: getPerformanceMetric parameters: - in: query name: cmpProjectIds schema: items: format: int64 type: integer type: array - in: query name: depotEntryIds schema: items: format: int64 type: integer type: array - in: query name: groupBy schema: type: string - in: query name: metricType schema: type: string - in: query name: rangeKey schema: type: integer responses: 200: content: application/json: schema: $ref: "#/components/schemas/PerformanceMetric" application/xml: schema: $ref: "#/components/schemas/PerformanceMetric" tags: ["PerformanceMetric"] "/performance-metric/export": get: operationId: getPerformanceMetricExport parameters: - in: query name: cmpProjectIds schema: items: format: int64 type: integer type: array - in: query name: depotEntryIds schema: items: format: int64 type: integer type: array - in: query name: groupBy schema: type: string - in: query name: metricType schema: type: string - in: query name: rangeKey schema: type: integer responses: 200: content: text/csv: schema: format: binary type: string headers: Content-Disposition: schema: type: string tags: ["PerformanceMetric"] "/performance-overview-metric": get: operationId: getPerformanceOverviewMetric parameters: - in: query name: cmpProjectIds schema: items: format: int64 type: integer type: array - in: query name: depotEntryIds schema: items: format: int64 type: integer type: array - in: query name: rangeKey schema: type: integer responses: 200: content: application/json: schema: $ref: "#/components/schemas/PerformanceOverviewMetric" application/xml: schema: $ref: "#/components/schemas/PerformanceOverviewMetric" tags: ["PerformanceOverviewMetric"] "/performance-top-asset": get: operationId: getPerformanceTopAssetPage parameters: - in: query name: cmpProjectIds schema: items: format: int64 type: integer type: array - in: query name: depotEntryIds schema: items: format: int64 type: integer type: array - in: query name: filter schema: type: string - in: query name: nestedFields required: false schema: type: string - in: query name: page schema: format: int64 type: integer - in: query name: pageSize schema: format: int64 type: integer - in: query name: rangeKey schema: type: integer - in: query name: search schema: type: string - in: query name: sort schema: type: string responses: 200: content: application/json: schema: items: $ref: "#/components/schemas/PerformanceTopAsset" type: array application/xml: schema: items: $ref: "#/components/schemas/PerformanceTopAsset" type: array tags: ["PerformanceTopAsset"] "/performance-top-asset/export": get: operationId: getPerformanceTopAssetExport parameters: - in: query name: cmpProjectIds schema: items: format: int64 type: integer type: array - in: query name: depotEntryIds schema: items: format: int64 type: integer type: array - in: query name: filter schema: type: string - in: query name: rangeKey schema: type: integer - in: query name: search schema: type: string - in: query name: sort schema: type: string responses: 200: content: text/csv: schema: format: binary type: string headers: Content-Disposition: schema: type: string tags: ["PerformanceTopAsset"]