Use this resource to export reports that are too large to be computed on the UI. A report is exported to raw CSV.

The maximum report size for raw exports is 1 GB. Exporting a report of this size may take up to 20 minutes.

You can export a report based on:

• The URI of the report (the latest report definition will be used)

• The URI of a report definition

How it works

1. You make an API call to export a report.
2. The API returns the URL to poll on the export progress. Depending on whether the report is still calculating or not, various HTTP codes are returned.
3. When the report is calculated, the response returns 200 and the exported report as raw CSV. If the exported report is empty, the response returns 204.

Filtering out report data to be exported

You can add a dynamic filter definition to the request body to filter out data to be exported. To do so, add the context parameter and define the filters. For example:

{
  "report_req": {
    "report": "/gdc/md/{project_id}/obj/{report_object_id}",
    "context": {
      "filters": [
        {
          "uri": "/gdc/md/{project_id}/obj/{filter_id}",
          "constraint": {
            "type": "list",
            "elements": [
              "/gdc/md/{project_id}/obj/{attribute}/elements?id={displayForm_1_id}",
              "/gdc/md/{project_id}/obj/{attribute}/elements?id={displayForm_2_id}"
            ]
          }
        },
        {
          "uri": "/gdc/md/{project_id}/obj/{filter_id}",
          "constraint": {
            "type": "floating",
            "from": -1,
            "to": -1
          }
        },
        {
          "uri": "/gdc/md/{project_id}/obj/{filter_id}",
          "constraint": {
            "type": "interval",
            "from": "2015-07-01",
            "to": "2015-07-10"
          }
        }
      ]
    }
  }
}

where:

• List filters can be used for filtering attribute items.

• Floating filters can be used for filtering date attributes (previous period, next period). The from and to properties respect filter granularity.

• Interval filters can be used for filtering date attributes for a specific interval. The from and to properties respect filter granularity.

{
  "report_req": {
    "report": "/gdc/md/{project_id}/obj/{report_id}"
  }
}

"\"Month/Year\",\"Income\"\n\"Jan 2015\",\"18022\"\n\"Feb 2015\",\"1794\"\n\"Mar 2015\",\"216991\"\n\"Apr 2015\",\"24798\"\n\"May 2015\",\"25689\"\n\"Jun 2015\",\"2340\""