studio.reports.list

List Data Studio reports.

Facts

Arguments

Required arguments

Optional arguments

Usage info

• Returns reports ordered by creation date, newest first.
• Organization API keys can list Data Studio reports in the account.
• Personal access tokens only return reports the token owner can view.

Example request

This is a typical request:

curl -X GET 'https://api.getdx.com/studio.reports.list?limit=50' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer xxxx-xxxxxxxxx-xxxx'

Example response

This is a typical success response:

{
  "ok": true,
  "reports": [
    {
      "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",
      "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"
    }
  ],
  "response_metadata": {
    "next_cursor": null
  }
}

Each item in the reports array is a Studio Report object.

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok param in the response.