DX API Support for Express Reports
  • 12 Mar 2021
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

DX API Support for Express Reports

  • Dark
    Light
  • PDF

Article Summary

The web service returns Express Report data from any requested time period for which Express data is available. You do not have to add anything to your Data Extraction API request to get Express Report data.

Note: A report may be Express Analysis compliant, but may not contain express data. In the Analytics and Administration user interfaces, the clock icon means that a report actually contains express data, and the "Express Analysis" label means that a report is compliant for express analysis. Data Extraction API responses contain the attribute IsRealTimeCompatible or the property ContainsRealtimeData to indicate this.

Express Reports: Data Extraction API Responses

  • The list report time periods method returns the Express Report time periods as a list of periods with the identifier RealTime.
  • The get report definition method includes in its response a true-or-false attribute, IsRealTimeCompatible, to indicate that a report is Express Analysis compliant.
  • The get report data for period method also includes the attribute IsRealTimeCompatible, as well as IsHierachy (if a drilldown) and intervalsEnabled.
  • If the report property ContainsRealtimeData is true, the report contains Express data.
  • Reports with Express data are cached for only 10 minutes.
  • The value of the LastUpdate property on a report depends on the type of report:
    • For a regular report, its value is the date and time the last analysis was performed.
    • For an Express report, it is the most recent update to Express data.

Was this article helpful?