Get All Pivot Tables in an Excel Worksheet

A PivotTable is a data‑summarization tool in Excel that lets you reorganize and analyze large data sets. This REST API retrieves information about all PivotTables in a specified worksheet.

REST API

GET https://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/pivottables

Request parameters

Parameter Name	Type	Location	Description
name	string	path	Name of the Excel document.
sheetName	string	path	Name of the worksheet.
folder	string	query	Folder where the document is stored.
storageName	string	query	Name of the storage service.

The OpenAPI Specification defines a publicly accessible programming interface and lets you carry out REST interactions directly from a web browser.

Request

curl -v "https://api.aspose.cloud/v3.0/cells/Sample_Pivot_Table_Example.xls/worksheets/Sheet2/pivottables" \
  -X GET \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <jwt token>"

Response

{
  "PivotTables": {
    "PivotTableList": [
      {
        "link": {
          "Href": "/0",
          "Rel": "self"
        }
      }
    ],
    "link": {
      "Href": "https://api.aspose.cloud/v3.0/cells/Sample_Pivot_Table_Example.xls/worksheets/Sheet2",
      "Rel": "self"
    }
  },
  "Code": "200",
  "Status": "OK"
}

Error Responses

HTTP Code	Description	Sample JSON Payload
400	Bad request – required parameter missing.	`{ "Code": "400", "Message": "Missing required parameter." }`
401	Unauthorized – invalid or missing token.	`{ "Code": "401", "Message": "Authentication failed." }`
404	Not found – workbook, worksheet, or pivot table does not exist.	`{ "Code": "404", "Message": "Resource not found." }`
500	Internal server error – unexpected condition on the server.	`{ "Code": "500", "Message": "Server error." }`

Cloud SDK Family

Using an SDK is the fastest way to develop. An SDK handles low‑level details so you can focus on your project. Please check out the GitHub repository for a complete list of Aspose.Cells Cloud SDKs.

The following code examples demonstrate how to call Aspose.Cells web services using various SDKs:

Get a Pivot Table in an Excel Worksheet Add a pivot table in an Excel worksheet