List Extract Refresh Tasks

Retrieves a list of extract refresh tasks for the Tableau site. Each task describes a scheduled refresh for a data source or workbook extract and includes schedule information (e.g. frequency, next run time, schedule name on Server).

Admin Only

This tool is restricted to Tableau site administrators and requires the ADMIN_TOOLS_ENABLED environment variable to be enabled.

APIs called

• Get Extract Refresh Tasks

Use cases

Use this tool when you need to:

• See which data sources or workbooks have extract refresh schedules
• Find the refresh schedule (frequency, next run time) for specific datasources or workbooks
• List all extract refresh tasks on the site
• Analyze extract refresh patterns for schedule optimization

Required permissions

• Tableau Cloud: Requires tableau:tasks:read OAuth scope
• Tableau Server: Users see only tasks they own unless they are site or server administrators
• Site Role: Must be one of:
  • SiteAdministratorCreator
  • SiteAdministratorExplorer
  • ServerAdministrator

Configuration

Enable this tool by setting:

ADMIN_TOOLS_ENABLED=true

See also: Environment Variables

Arguments

Parameter	Type	Required	Description
filter	string	No	Client-side filter string with format field:operator:value. Multiple filters are comma-separated (AND logic).
pageSize	number	No	Maximum number of results to return after filtering (client-side).
limit	number	No	Maximum number of results to return after filtering (client-side). If both pageSize and limit are set, the smaller value applies.

API Limitation

The Tableau REST API does not support server-side filtering or pagination for extract refresh tasks — all tasks are fetched in a single request. This tool applies filter, pageSize, and limit client-side after fetching.

Filterable fields

Field	Type	Operators	Example
id	string	eq, in	id:eq:abc123
type	string	eq, in	type:eq:RefreshExtractTask
priority	number	eq, gt, gte, lt, lte	priority:gte:5
consecutiveFailedCount	number	eq, gt, gte, lt, lte	consecutiveFailedCount:gt:0
datasource.id	string	eq, in	datasource.id:eq:ds-123
workbook.id	string	eq, in	workbook.id:eq:wb-456
schedule.id	string	eq, in	schedule.id:eq:sched-789
schedule.name	string	eq, in	schedule.name:eq:Daily Refresh
schedule.state	string	eq, in	schedule.state:eq:Active
schedule.frequency	string	eq, in	schedule.frequency:eq:Daily
schedule.nextRunAt	string (ISO 8601)	eq, gt, gte, lt, lte	schedule.nextRunAt:lt:2026-05-25T00:00:00Z
schedule.createdAt	string (ISO 8601)	eq, gt, gte, lt, lte	schedule.createdAt:gte:2026-01-01T00:00:00Z
schedule.updatedAt	string (ISO 8601)	eq, gt, gte, lt, lte	schedule.updatedAt:gte:2026-05-01T00:00:00Z

Filter examples

• Single filter: schedule.frequency:eq:Daily
• Multiple filters (AND): schedule.frequency:eq:Daily,priority:gte:5
• IN operator (bracketed list): schedule.frequency:in:[Daily,Weekly]

Response structure

Each task includes:

• id – extract refresh task ID
• datasource.id or workbook.id – the target data source or workbook
• schedule – frequency, nextRunAt, and (on Tableau Server) name, state, id
  • frequency – Daily, Weekly, Monthly, or Hourly
  • nextRunAt – ISO 8601 timestamp of next scheduled run
  • frequencyDetails.intervals – detailed interval configuration (hours, minutes, weekDay, monthDay)

Example result

[
  {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "datasource": {
      "id": "2d935df8-fe7e-4fd8-bb14-35eb4ba31d45"
    },
    "schedule": {
      "id": "schedule-123",
      "name": "Daily Early Morning",
      "state": "Active",
      "frequency": "Daily",
      "nextRunAt": "2026-05-21T06:00:00Z",
      "frequencyDetails": {
        "intervals": {
          "interval": [
            {
              "hours": 6,
              "minutes": 0
            }
          ]
        }
      }
    }
  },
  {
    "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "workbook": {
      "id": "3e046e08-f8a3-4f09-c26f-46fa5b8bef13"
    },
    "schedule": {
      "id": "schedule-456",
      "name": "Weekly Sunday",
      "state": "Active",
      "frequency": "Weekly",
      "nextRunAt": "2026-05-25T08:00:00Z",
      "frequencyDetails": {
        "intervals": {
          "interval": [
            {
              "weekDay": "Sunday",
              "hours": 8,
              "minutes": 0
            }
          ]
        }
      }
    }
  }
]

Empty result

If no extract refresh tasks are found, the tool returns a message:

No extract refresh tasks were found. Either none exist or you do not have permission to view them.