---
title: "Create a report"
method: POST
path: "/{globalCompanyId}/reports"
tags: ["Reports"]
---

# Create a report

`POST /{globalCompanyId}/reports`

For more information, see the [Reporting API guide](https://developer.adobe.com/analytics-apis/docs/2.0/guides/endpoints/reports/).

## Path parameters

- `globalCompanyId` string, required

## Headers

- `Authorization` string, required
- `x-api-key` string, required

## Request body

- RankedRequest
  - `rsid` string
  - `dimension` string
  - `locale` Locale
    - `language` string
    - `script` string
    - `country` string
    - `variant` string
    - `extensionKeys` string[]
    - `unicodeLocaleAttributes` string[]
    - `unicodeLocaleKeys` string[]
    - `iso3Language` string
    - `iso3Country` string
    - `displayLanguage` string
    - `displayScript` string
    - `displayCountry` string
    - `displayVariant` string
    - `displayName` string
  - `globalFilters` ReportFilter[]
    - `id` string
    - `type` 'dateRange' | 'breakdown' | 'segment' | 'excludeItemIds'
    - `dimension` string
    - `itemId` string
    - `itemIds` string[]
    - `segmentId` string
    - `segmentDefinition` AnalyticsSegmentDefinition
      - `container` object
        - `context` string
        - `func` string
        - `pred` object
          - `val` object
            - `description` string
            - `name` string
            - `func` string
          - `str` string
          - `func` string
      - `func` string
      - `version` integer[]
    - `dateRange` string
    - `dateRangeRelative` string
    - `excludeItemIds` string[]
  - `search` ReportSearch
    - `clause` string
    - `excludeItemIds` string[]
    - `itemIds` string[]
    - `includeSearchTotal` boolean
    - `empty` boolean
  - `settings` RankedSettings
    - `limit` integer
    - `page` integer
    - `dimensionSort` string
    - `countRepeatInstances` boolean
    - `reflectRequest` boolean
    - `includeAnomalyDetection` boolean
    - `includeForecasting` boolean
    - `includePercentChange` boolean
    - `includeLatLong` boolean
    - `nonesBehavior` string
  - `statistics` RankedStatistics
    - `functions` string[]
    - `ignoreZeroes` boolean
  - `metricContainer` ReportMetrics
    - `metricFilters` ReportFilter[]
      - `id` string
      - `type` 'dateRange' | 'breakdown' | 'segment' | 'excludeItemIds'
      - `dimension` string
      - `itemId` string
      - `itemIds` string[]
      - `segmentId` string
      - `segmentDefinition` AnalyticsSegmentDefinition
        - `container` object
          - `context` string
          - `func` string
          - `pred` object
            - `val` object
              - …
            - `str` string
            - `func` string
        - `func` string
        - `version` integer[]
      - `dateRange` string
      - `dateRangeRelative` string
      - `excludeItemIds` string[]
    - `metrics` ReportMetric[]
      - `id` string
      - `columnId` string
      - `filters` string[]
      - `sort` string
      - `metricDefinition` object
      - `predictive` ReportMetricPredictiveSettings
        - `anomalyConfidence` number, double
  - `rowContainer` ReportRows
    - `rowFilters` ReportFilter[]
      - `id` string
      - `type` 'dateRange' | 'breakdown' | 'segment' | 'excludeItemIds'
      - `dimension` string
      - `itemId` string
      - `itemIds` string[]
      - `segmentId` string
      - `segmentDefinition` AnalyticsSegmentDefinition
        - `container` object
          - `context` string
          - `func` string
          - `pred` object
            - `val` object
              - …
            - `str` string
            - `func` string
        - `func` string
        - `version` integer[]
      - `dateRange` string
      - `dateRangeRelative` string
      - `excludeItemIds` string[]
    - `rows` ReportRow[]
      - `rowId` string
      - `filters` string[]
  - `anchorDate` string

## Response `200`

Successful operation

- RankedReportData
  - `totalPages` integer
  - `firstPage` boolean
  - `lastPage` boolean
  - `numberOfElements` integer
  - `number` integer
  - `totalElements` integer
  - `message` string
  - `request` RankedRequest
    - `rsid` string
    - `dimension` string
    - `locale` Locale
      - `language` string
      - `script` string
      - `country` string
      - `variant` string
      - `extensionKeys` string[]
      - `unicodeLocaleAttributes` string[]
      - `unicodeLocaleKeys` string[]
      - `iso3Language` string
      - `iso3Country` string
      - `displayLanguage` string
      - `displayScript` string
      - `displayCountry` string
      - `displayVariant` string
      - `displayName` string
    - `globalFilters` ReportFilter[]
      - `id` string
      - `type` 'dateRange' | 'breakdown' | 'segment' | 'excludeItemIds'
      - `dimension` string
      - `itemId` string
      - `itemIds` string[]
      - `segmentId` string
      - `segmentDefinition` AnalyticsSegmentDefinition
        - `container` object
          - `context` string
          - `func` string
          - `pred` object
            - `val` object
              - …
            - `str` string
            - `func` string
        - `func` string
        - `version` integer[]
      - `dateRange` string
      - `dateRangeRelative` string
      - `excludeItemIds` string[]
    - `search` ReportSearch
      - `clause` string
      - `excludeItemIds` string[]
      - `itemIds` string[]
      - `includeSearchTotal` boolean
      - `empty` boolean
    - `settings` RankedSettings
      - `limit` integer
      - `page` integer
      - `dimensionSort` string
      - `countRepeatInstances` boolean
      - `reflectRequest` boolean
      - `includeAnomalyDetection` boolean
      - `includeForecasting` boolean
      - `includePercentChange` boolean
      - `includeLatLong` boolean
      - `nonesBehavior` string
    - `statistics` RankedStatistics
      - `functions` string[]
      - `ignoreZeroes` boolean
    - `metricContainer` ReportMetrics
      - `metricFilters` ReportFilter[]
        - `id` string
        - `type` 'dateRange' | 'breakdown' | 'segment' | 'excludeItemIds'
        - `dimension` string
        - `itemId` string
        - `itemIds` string[]
        - `segmentId` string
        - `segmentDefinition` AnalyticsSegmentDefinition
          - `container` object
            - `context` string
            - `func` string
            - `pred` object
              - …
          - `func` string
          - `version` integer[]
        - `dateRange` string
        - `dateRangeRelative` string
        - `excludeItemIds` string[]
      - `metrics` ReportMetric[]
        - `id` string
        - `columnId` string
        - `filters` string[]
        - `sort` string
        - `metricDefinition` object
        - `predictive` ReportMetricPredictiveSettings
          - `anomalyConfidence` number, double
    - `rowContainer` ReportRows
      - `rowFilters` ReportFilter[]
        - `id` string
        - `type` 'dateRange' | 'breakdown' | 'segment' | 'excludeItemIds'
        - `dimension` string
        - `itemId` string
        - `itemIds` string[]
        - `segmentId` string
        - `segmentDefinition` AnalyticsSegmentDefinition
          - `container` object
            - `context` string
            - `func` string
            - `pred` object
              - …
          - `func` string
          - `version` integer[]
        - `dateRange` string
        - `dateRangeRelative` string
        - `excludeItemIds` string[]
      - `rows` ReportRow[]
        - `rowId` string
        - `filters` string[]
    - `anchorDate` string
  - `reportId` string
  - `columns` RankedColumnMetaData
    - `dimension` ReportDimension
      - `id` string
      - `type` 'STRING' | 'INT' | 'DECIMAL' | 'CURRENCY' | 'PERCENT' | 'TIME' | 'ENUM' | 'ORDERED_ENUM'
    - `columnIds` string[]
    - `columnErrors` RankedColumnError[]
      - `columnId` string
      - `errorCode` 'unauthorized_metric' | 'unauthorized_dimension' | 'unauthorized_dimension_global' | 'anomaly_detection_failure_unexpected_item_count' | 'anomaly_detection_failure_tsa_service' | 'not_enabled_metric' | 'not_enabled_dimension' | 'not_enabled_dimension_global'
      - `errorId` string
      - `errorDescription` string
  - `rows` Row[]
    - `itemId` string
    - `value` string
    - `rowId` string
    - `data` number[]
    - `dataExpected` number[]
    - `dataUpperBound` number[]
    - `dataLowerBound` number[]
    - `dataAnomalyDetected` boolean[]
    - `percentChange` number[]
    - `latitude` number, double
    - `longitude` number, double
    - `dataForecasted` number[]
    - `dataForecastedUpperBound` number[]
    - `dataForecastedLowerBound` number[]
  - `summaryData` RankedSummaryData

## Other responses

- `206` — Partially successful operation. Some response columns contain errors. See the [Partial Responses](https://github.com/AdobeDocs/analytics-2.0-apis/blob/master/reporting-guide.md#partial-responses-206-status-code) for details.
- `400` — Invalid input; name, rsid, and definition are all required. Definition must be formatted as a JSON Object.

## Changes

- **2025-08-07** `f13c80692287` — 1 warning
  - deleted the `header` request parameter `x-gw-ims-org-id`
- **2025-08-06** `f49e893a6c2b` — 1 breaking
  - added the new required `header` request parameter `x-gw-ims-org-id`
- **2022-05-10** `dcd4514630c4` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/adobe/apis/adobe-analytics-apis/changes/:globalCompanyId/reports/post.md)

---

[API](https://skmtc.dev/adobe/apis/adobe-analytics-apis.md) · [All operations](https://skmtc.dev/adobe/apis/adobe-analytics-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/adobe/adobe-analytics-apis/revisions/b2e01ce0f30a/schema)