Skip to main content

Search Content

Searches across all supported content types in a Tableau Site for objects relevant to the search query.

APIs called​

Optional arguments​

terms​

A string containing one or more search terms that the search uses as the basis for determining which items are relevant to return. If the terms parameter is not provided, it searches for everything bound by the specified filters.

Example: "Regional Sales"

limit​

The number of items to return in the search response. Default limit is 100 and max value is 2000 items.

Example: 100

See also: MAX_RESULT_LIMIT

orderBy​

Determines the sorting method for returned items. Available sorting methods:

  • hitsTotal: Number of times a content item has been viewed since it was created
  • hitsSmallSpanTotal: Number of times a content item was viewed in the last month
  • hitsMediumSpanTotal: Number of times a content item was viewed in the last 3 months
  • hitsLargeSpanTotal: Number of times a content item was viewed in the last year
  • downstreamWorkbookCount: Number of workbooks in a given project. This value is only available when the content type filter includes 'database' or 'table'

For each sort method, you can specify a sort direction: "asc" for ascending or "desc" for descending (default: "asc").

The orderBy parameter is an array of objects containing the sorting method and direction. The first element determines primary sorting, with subsequent elements used as tiebreakers.

If the orderBy parameter is omitted, the search will sort items by their "relevance score" in descending order, which is Tableau's internal algorithm for providing the most relevant results.

Example:

[
  {
    "method": "hitsSmallSpanTotal",
    "sortDirection": "desc"
  },
  {
    "method": "hitsMediumSpanTotal",
    "sortDirection": "desc"
  }
]

filter​

An object that allows you to limit search results based on:

  • contentTypes: Filter by content types (array of strings). Supported types are: lens, datasource, virtualconnection, collection, project, flow, datarole, table, database, view, workbook
  • ownerIds: Filter by specific owner IDs (array of integers)
  • modifiedTime: Filter by last modified times using ISO 8601 date-time strings. Can be either a range (with startDate/endDate) or an array of specific date-times to include

The filter parameter is optional, but if it is provided it requires at least one of the three filtering methods (contentTypes, ownerIds, or modifiedTime)

Example:

{
  "contentTypes": ["workbook","datasource"],
  "modifiedTime": {
    "startDate": "2025-01-01T00:00:00.000Z"
  }
}

Example:

{
  "ownerIds": [12345,67890],
  "modifiedTime": [
    "2025-02-01T20:01:03Z",
    "2024-11-15T14:23:07Z",
    "2024-12-08T09:45:33Z",
    "2025-01-22T16:12:58Z",
    "2025-03-07T11:37:21Z",
    "2025-04-18T20:55:14Z"
  ]
}

Example result​

[
  {
    "modifiedTime": "2025-09-19T18:52:18.475Z",
    "type": "workbook",
    "ownerId": 325277,
    "title": "Income Trends with Age",
    "ownerName": "Lucia Orange",
    "containerName": "Research",
    "luid": "d9870a9b-4934-4ebc-a9ee-5fc723c79590",
    "totalViewCount": 3061,
    "favoritesTotal": 1,
    "viewCountLastMonth": 105,
    "hasExtracts": true,
    "extractCreationPending": false
  },
  {
    "modifiedTime": "2025-08-28T20:11:05.699Z",
    "sheetType": "dashboard",
    "workbookDescription": "This dashboard contains KPIs for e bike manufactures within our network.",
    "type": "view",
    "ownerId": 461938,
    "title": "Manufacturer Overview",
    "ownerName": "Maria Stone",
    "parentWorkbookName": "eBikes Analytics",
    "luid": "b4457c0b-5eeb-4cbc-b1ae-47ed1d90cee7",
    "locationName": "2025 Reports",
    "totalViewCount": 3991,
    "favoritesTotal": 7,
    "projectName": "2025 Reports",
    "viewCountLastMonth": 567
  },
  {
    "modifiedTime": "2025-09-24T20:10:35.437Z",
    "type": "unifieddatasource",
    "ownerId": 411957,
    "title": "Test Report Data",
    "ownerName": "Bruce Springtail",
    "containerName": "Data Sources",
    "luid": "86712226-f5d6-4712-8426-074e5070fb77",
    "totalViewCount": 42260,
    "favoritesTotal": 3,
    "viewCountLastMonth": 1947,
    "isConnectable": true,
    "datasourceIsPublished": true,
    "connectionType": "snowflake",
    "isCertified": false,
    "hasExtracts": true,
    "extractRefreshedAt": "2025-09-24T20:10:35.385Z",
    "extractUpdatedAt": "2025-09-24T20:10:35.385Z",
    "connectedWorkbooksCount": 228,
    "extractCreationPending": false,
    "hasSevereDataQualityWarning": false,
    "datasourceLuid": "a9af708b-0d44-48f8-23e2-4ee4b12446b2",
    "hasActiveDataQualityWarning": false
  },
]