Open documentation ↗Overview
<fullname>Amazon QuickSight API Reference</fullname> <p>Amazon QuickSight is a fully managed, serverless business intelligence service for the Amazon Web Services Cloud that makes it easy to extend data and insights to every user in your organization. This API reference contains documentation for a programming interface that you can use to manage Amazon QuickSight. </p>
Amazon QuickSight is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 134 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Cloud Platforms
- Version
- 2018-04-01
- Endpoints
- 134
- OpenAPI
- Specification ↗
- Spec updated
- 2020-03-11
Endpoints
| Method | Path | What it does |
|---|---|---|
| GET | /accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId} | Describes a SPICE ingestion. |
| PUT | /accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId} | <p>Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You |
| DELETE | /accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId} | Cancels an ongoing ingestion of data into SPICE. |
| GET | /accounts/{AwsAccountId}/customizations | <p>Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon QuickSight namespace in an Amazon Web Services Region |
| POST | /accounts/{AwsAccountId}/customizations | <p>Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a custom default theme by using the <code>CreateA |
| PUT | /accounts/{AwsAccountId}/customizations | <p>Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.</p> <p>Yo |
| DELETE | /accounts/{AwsAccountId}/customizations | Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace. |
| GET | /account/{AwsAccountId} | Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription. A successful API call returns an <code>Ac |
| POST | /account/{AwsAccountId} | <p>Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.</p> <p>The Amazon Web Services Region for the account is derived from what is con |
| DELETE | /account/{AwsAccountId} | Use the <code>DeleteAccountSubscription</code> operation to delete an Amazon QuickSight account. This operation will result in an error message if you have conf |
| GET | /accounts/{AwsAccountId}/analyses/{AnalysisId} | Provides a summary of the metadata for an analysis. |
| POST | /accounts/{AwsAccountId}/analyses/{AnalysisId} | Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an <code>AnalysisDefinition</code>. |
| PUT | /accounts/{AwsAccountId}/analyses/{AnalysisId} | Updates an analysis in Amazon QuickSight |
| DELETE | /accounts/{AwsAccountId}/analyses/{AnalysisId} | <p>Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a re |
| GET | /accounts/{AwsAccountId}/dashboards/{DashboardId} | Provides a summary for a dashboard. |
| POST | /accounts/{AwsAccountId}/dashboards/{DashboardId} | <p>Creates a dashboard from either a template or directly with a <code>DashboardDefinition</code>. To first create a template, see the <code> <a href="https://d |
| PUT | /accounts/{AwsAccountId}/dashboards/{DashboardId} | <p>Updates a dashboard in an Amazon Web Services account.</p> <note> <p>Updating a Dashboard creates a new dashboard version but does not immediately publish th |
| DELETE | /accounts/{AwsAccountId}/dashboards/{DashboardId} | Deletes a dashboard. |
| GET | /accounts/{AwsAccountId}/data-sets | <p>Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.</p> <p>The permissions resource is <code>arn |
| POST | /accounts/{AwsAccountId}/data-sets | Creates a dataset. This operation doesn't support datasets that include uploaded files as a source. |
| GET | /accounts/{AwsAccountId}/data-sources | Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account. |
| POST | /accounts/{AwsAccountId}/data-sources | Creates a data source. |
| GET | /accounts/{AwsAccountId}/folders/{FolderId} | Describes a folder. |
| POST | /accounts/{AwsAccountId}/folders/{FolderId} | Creates an empty shared folder. |
| PUT | /accounts/{AwsAccountId}/folders/{FolderId} | Updates the name of a folder. |
| DELETE | /accounts/{AwsAccountId}/folders/{FolderId} | Deletes an empty folder. |
| PUT | /accounts/{AwsAccountId}/folders/{FolderId}/members/{MemberType}/{MemberId} | Adds an asset, such as a dashboard, analysis, or dataset into a folder. |
| DELETE | /accounts/{AwsAccountId}/folders/{FolderId}/members/{MemberType}/{MemberId} | Removes an asset, such as a dashboard, analysis, or dataset, from a folder. |
| GET | /accounts/{AwsAccountId}/namespaces/{Namespace}/groups | Lists all user groups in Amazon QuickSight. |
| POST | /accounts/{AwsAccountId}/namespaces/{Namespace}/groups | <p>Use the <code>CreateGroup</code> operation to create a group in Amazon QuickSight. You can create up to 10,000 groups in a namespace. If you want to create m |
| GET | /accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName} | Use the <code>DescribeGroupMembership</code> operation to determine if a user is a member of the specified group. If the user exists and is a member of the spec |
| PUT | /accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName} | Adds an Amazon QuickSight user to an Amazon QuickSight group. |
| DELETE | /accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName} | Removes a user from a group so that the user is no longer a member of the group. |
| POST | /accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments/ | Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or |
| POST | /accounts/{AwsAccountId} | <p>(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.</p> <p>A namespace allows you to isolate the Amazon QuickSight users |
| GET | /accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules | Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules. |
| POST | /accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules | Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset. |
| PUT | /accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules | Updates a refresh schedule for a dataset. |
| GET | /accounts/{AwsAccountId}/templates/{TemplateId} | Describes a template's metadata. |
| POST | /accounts/{AwsAccountId}/templates/{TemplateId} | <p>Creates a template either from a <code>TemplateDefinition</code> or from an existing Amazon QuickSight analysis or template. You can use the resulting templa |
| PUT | /accounts/{AwsAccountId}/templates/{TemplateId} | Updates a template from an existing Amazon QuickSight analysis or another template. |
| DELETE | /accounts/{AwsAccountId}/templates/{TemplateId} | Deletes a template. |
| GET | /accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName} | Describes the template alias for a template. |
| POST | /accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName} | Creates a template alias for a template. |
| PUT | /accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName} | Updates the template alias of a template. |
| DELETE | /accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName} | Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to. |
| GET | /accounts/{AwsAccountId}/themes/{ThemeId} | Describes a theme. |
| POST | /accounts/{AwsAccountId}/themes/{ThemeId} | <p>Creates a theme.</p> <p>A <i>theme</i> is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, s |
| PUT | /accounts/{AwsAccountId}/themes/{ThemeId} | Updates a theme. |
| DELETE | /accounts/{AwsAccountId}/themes/{ThemeId} | Deletes a theme. |
| GET | /accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName} | Describes the alias for a theme. |
| POST | /accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName} | Creates a theme alias for a theme. |
| PUT | /accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName} | Updates an alias of a theme. |
| DELETE | /accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName} | Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias p |
| GET | /accounts/{AwsAccountId}/data-sets/{DataSetId} | Describes a dataset. This operation doesn't support datasets that include uploaded files as a source. |
| PUT | /accounts/{AwsAccountId}/data-sets/{DataSetId} | Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation. |
| DELETE | /accounts/{AwsAccountId}/data-sets/{DataSetId} | Deletes a dataset. |
| GET | /accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties | Describes the refresh properties of a dataset. |
| PUT | /accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties | Creates or updates the dataset refresh properties for the dataset. |
| DELETE | /accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties | Deletes the dataset refresh properties of the dataset. |
| GET | /accounts/{AwsAccountId}/data-sources/{DataSourceId} | Describes a data source. |
| PUT | /accounts/{AwsAccountId}/data-sources/{DataSourceId} | Updates a data source. |
| DELETE | /accounts/{AwsAccountId}/data-sources/{DataSourceId} | Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source. |
| GET | /accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName} | Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN). |
| PUT | /accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName} | Changes a group description. |
| DELETE | /accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName} | Removes a user group from Amazon QuickSight. |
| DELETE | /accounts/{AwsAccountId}/namespace/{Namespace}/iam-policy-assignments/{AssignmentName} | Deletes an existing IAM policy assignment. |
| GET | /accounts/{AwsAccountId}/namespaces/{Namespace} | Describes the current namespace. |
| DELETE | /accounts/{AwsAccountId}/namespaces/{Namespace} | Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, dat |
| GET | /accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules/{ScheduleId} | Provides a summary of a refresh schedule. |
| DELETE | /accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules/{ScheduleId} | Deletes a refresh schedule from a dataset. |
| GET | /accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName} | Returns information about a user, given the user name. |
| PUT | /accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName} | Updates an Amazon QuickSight user. |
| DELETE | /accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName} | Deletes the Amazon QuickSight user that is associated with the identity of the IAM user or role that's making the call. The IAM user isn't deleted as a result o |
| DELETE | /accounts/{AwsAccountId}/namespaces/{Namespace}/user-principals/{PrincipalId} | Deletes a user identified by its principal ID. |
| GET | /accounts/{AwsAccountId}/settings | Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account. |
| PUT | /accounts/{AwsAccountId}/settings | Updates the Amazon QuickSight settings in your Amazon Web Services account. |
| GET | /accounts/{AwsAccountId}/analyses/{AnalysisId}/definition | <p>Provides a detailed description of the definition of an analysis.</p> <note> <p>If you do not need to know details about the content of an Analysis, for inst |
| GET | /accounts/{AwsAccountId}/analyses/{AnalysisId}/permissions | Provides the read and write permissions for an analysis. |
| PUT | /accounts/{AwsAccountId}/analyses/{AnalysisId}/permissions | Updates the read and write permissions for an analysis. |
| GET | /accounts/{AwsAccountId}/dashboards/{DashboardId}/definition | <p>Provides a detailed description of the definition of a dashboard.</p> <note> <p>If you do not need to know details about the content of a dashboard, for inst |
| GET | /accounts/{AwsAccountId}/dashboards/{DashboardId}/permissions | Describes read and write permissions for a dashboard. |
| PUT | /accounts/{AwsAccountId}/dashboards/{DashboardId}/permissions | Updates read and write permissions on a dashboard. |
| GET | /accounts/{AwsAccountId}/data-sets/{DataSetId}/permissions | <p>Describes the permissions on a dataset.</p> <p>The permissions resource is <code>arn:aws:quicksight:region:aws-account-id:dataset/data-set-id</code>.</p> |
| POST | /accounts/{AwsAccountId}/data-sets/{DataSetId}/permissions | <p>Updates the permissions on a dataset.</p> <p>The permissions resource is <code>arn:aws:quicksight:region:aws-account-id:dataset/data-set-id</code>.</p> |
| GET | /accounts/{AwsAccountId}/data-sources/{DataSourceId}/permissions | Describes the resource permissions for a data source. |
| POST | /accounts/{AwsAccountId}/data-sources/{DataSourceId}/permissions | Updates the permissions to a data source. |
| GET | /accounts/{AwsAccountId}/folders/{FolderId}/permissions | Describes permissions for a folder. |
| PUT | /accounts/{AwsAccountId}/folders/{FolderId}/permissions | Updates permissions of a folder. |
| GET | /accounts/{AwsAccountId}/folders/{FolderId}/resolved-permissions | Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders. |
| GET | /accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments/{AssignmentName} | Describes an existing IAM policy assignment, as specified by the assignment name. |
| PUT | /accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments/{AssignmentName} | Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request. This overwrites a |
| GET | /accounts/{AwsAccountId}/ip-restriction | Provides a summary and status of IP rules. |
| POST | /accounts/{AwsAccountId}/ip-restriction | Updates the content and status of IP rules. To use this operation, you need to provide the entire map of rules. You can use the <code>DescribeIpRestriction</cod |
| GET | /accounts/{AwsAccountId}/templates/{TemplateId}/definition | <p>Provides a detailed description of the definition of a template.</p> <note> <p>If you do not need to know details about the content of a template, for instan |
| GET | /accounts/{AwsAccountId}/templates/{TemplateId}/permissions | Describes read and write permissions on a template. |
| PUT | /accounts/{AwsAccountId}/templates/{TemplateId}/permissions | Updates the resource permissions for a template. |
| GET | /accounts/{AwsAccountId}/themes/{ThemeId}/permissions | Describes the read and write permissions for a theme. |
| PUT | /accounts/{AwsAccountId}/themes/{ThemeId}/permissions | <p>Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example <code>"quicksight:DescribeTheme" |
| POST | /accounts/{AwsAccountId}/embed-url/anonymous-user | <p>Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Befor |
Showing the first 100 of 134 endpoints; the full list is in the documentation.
Questions
Does the Amazon QuickSight API need an API key?
Yes. The Amazon QuickSight API uses API key authentication; the documentation explains how to get credentials.
Does the Amazon QuickSight API support HTTPS?
Yes, the Amazon QuickSight API is served over HTTPS.
How many endpoints does the Amazon QuickSight API have?
Its OpenAPI description lists 134 endpoints in version 2018-04-01. The first 100 are shown on this page.
What are alternatives to the Amazon QuickSight API?
Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.
Similar cloud platforms APIs
Compare alternatives →Remote Settings PROD
Cloud PlatformsFirefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.
Linode API
Cloud Platforms## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se
DigitalOcean API
Cloud Platforms# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having
Vercel API
Cloud PlatformsVercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.
Platform API
Cloud PlatformsThe [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.
Azure Data Lake Storage
Cloud PlatformsAzure Data Lake Storage provides storage for Hadoop and other big data workloads.
Listed from APIs.guru (CC0).