Adobe Analytics · Schema

ReportResponse

The result of an analytics report request

AdobeAnalyticsBusiness IntelligenceCustomer IntelligenceDigital MarketingMarketingWeb Analytics

Properties

Name Type Description
totalPages integer Total number of result pages
numberOfElements integer Number of rows in this response
rows array
columns object Column metadata for the report
summaryData object Totals and summary statistics
View JSON Schema on GitHub

JSON Schema

adobe-analytics-report-response-schema.json Raw ↑
{
  "type": "object",
  "description": "The result of an analytics report request",
  "properties": {
    "totalPages": {
      "type": "integer",
      "description": "Total number of result pages",
      "example": 42
    },
    "numberOfElements": {
      "type": "integer",
      "description": "Number of rows in this response",
      "example": 10
    },
    "rows": {
      "type": "array",
      "example": [],
      "items": {
        "type": "object",
        "description": "A single row in a report result",
        "properties": {
          "itemId": {
            "type": "string",
            "description": "The dimension item ID",
            "example": "500123"
          },
          "value": {
            "type": "string",
            "description": "The dimension item display value",
            "example": "example_value"
          },
          "data": {
            "type": "array",
            "description": "Metric values for this row, in column order",
            "example": [],
            "items": {
              "type": "number"
            }
          }
        }
      }
    },
    "columns": {
      "type": "object",
      "description": "Column metadata for the report",
      "example": "example_value"
    },
    "summaryData": {
      "type": "object",
      "description": "Totals and summary statistics",
      "example": "example_value"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ReportResponse"
}