Studio Report

The definition for a Data Studio report returned by the Studio Reports API.

Example

{
  "id": "ou9lhoz888sa",
  "name": "Web Metrics",
  "description": "Main application web visit metrics",
  "markdown_notes": "## Objectives\n---\n* Provide high-level traffic metrics for marketing team\n* Surface for debugging reported web issues.",
  "view_access_type": "everyone",
  "edit_access_type": "read_only",
  "owner": {
    "id": "usr_abc123",
    "name": "Alice Example",
    "email": "alice@example.com"
  },
  "url": "https://app.getdx.com/datacloud/studio/reports/OTEzNA",
  "tiles": [
    {
      "id": "MTE4e2",
      "title": "Median visit duration",
      "sql": "SELECT avg(duration) AS avg_duration, week_start FROM custom.web_visits;",
      "chart_type": "line",
      "chart_config": {
        "xAxis": "week_start",
        "yAxes": ["avg_duration"]
      }
    }
  ],
  "created_at": "2026-03-12T19:56:11Z",
  "updated_at": "2026-05-12T10:46:12Z"
}

Properties

Key	Type	Description
`id`	string	The report’s public ID.
`name`	string	The report name.
`description`	string \| null	The report description.
`markdown_notes`	string \| null	Markdown notes shown with the report.
`view_access_type`	string	Who can view the report. See access types.
`edit_access_type`	string	Who can edit the report. See access types.
`owner`	object \| null	The report owner. See owner properties.
`url`	string	The URL for the report in DX.
`tiles`	array<Studio Report Tile>	The supported tiles on the report.
`created_at`	ISO8601 timestamp	When the report was created.
`updated_at`	ISO8601 timestamp	When the report was last updated.

Owner properties

Key	Type	Description
`id`	string	The owner’s user ID.
`name`	string	The owner’s display name.
`email`	string	The owner’s email address.

Access types

view_access_type can be one of:

Value	Description
`owner_and_direct_url_only`	Only the owner and direct URL access can view.
`everyone`	Everyone with Data Studio access can view.
`specific_users`	Only the owner, editors, and specified viewers can view.

edit_access_type can be one of:

Value	Description
`read_only`	Only the owner can edit.
`everyone`	Everyone with Data Studio access can edit.
`specific_users`	Only the owner and specified editors can edit.