Data Warehouse Reports

Data Warehouse data is available through the Reporting API.

You can run Data Warehouse reports in the Reporting API by setting "source":"warehouse" In the reportDescription object.

When using Report.Get, the returned report can include multiple pages. To get data beyond the first page, make additional requests to Report.Get and specify the page number in either the body or query string.

The API stores data warehouse data in zip format. When using Report.Get, it tries to unzip this data and transform it to JSON (or CSV) when returning it. The format query string parameter can be used to control how data is returned.

Data Warehouse API Best Practices

The Data Warehouse API is intended to be used to query large amounts of data from Adobe Analytics. Adobe recommends using this source over standard if reports take longer than about 2 hours to run.

Factors that can cause reports to run for a long time:

• Breakdowns that return a large number of values for each breakdown
• Requests for a year or more of data using granularity that is a day or less

If requesting a very large dataset (results greater than 20 MB), using the format=raw option is recommended as data will be ready the fastest and will take the least time to transfer. The API requires format=raw for zipped data warehouse results that exceed 50 MB in size and will indicate this as part of the Report.Get response. Raw format can be used on all requests if desired; it is only required if a report exceeds the 50 MB limit.

If not using format=raw and the dataset is less than 50 MB compressed but larger than 20 MB compressed, the page=X query parameter is required to retrieve all pages. page=X works on format=csv and format=JSON format types; it is ignored when used with the format=raw format type.

Requesting today's data

Data Warehouse requests wait to be processed until all of the data for the requested time period has been collected and processed. For example, if you request data for today, no data is be delivered or available when calling Report.Get until shortly after midnight. Including time information in the request enables you to request data from the current day as long as data within the provided timeframe has been collected and processed.

To maintain backward compatibility, an additional flag "fuzzyDates": false is required in the request body and will indicate to the Data Warehouse API that it should treat the provided dates as the exact timeframe being requested and not try to request full days.

For example:

Copy
{
  "reportDescription": {
    "reportSuiteID": "testreportsuite",
    "dateFrom": "YYYY-05-13 00:00:00",
    "dateTo": "YYYY-05-13 12:00:00",
    "fuzzyDates": false,
    "metrics": [
      {
        "id": "visits"
      }
    ],
    "elements": [
      {
        "id": "page",
      }
    ],
    "source": "warehouse"
  }
}
Copied to your clipboard
{
  "reportDescription": {
    "reportSuiteID": "testreportsuite",
    "dateFrom": "YYYY-05-13 00:00:00",
    "dateTo": "YYYY-05-13 12:00:00",
    "fuzzyDates": false,
    "metrics": [
      {
        "id": "visits"
      }
    ],
    "elements": [
      {
        "id": "page",
      }
    ],
    "source": "warehouse"
  }
}

Last updated 2/1/2023

Was this helpful?

Yes

No