RestApiCategories.visualizationAndReports.desc

visualization_and_reports

2025.08

2025.09

2025.10

2025.03

2025.11

2025.12

The Visual Analytics API provides simplified ways to perform basic tasks with reports. Tasks include exporting a report as a PDF file, or as a package file, or exporting an image of a part of the report.

Visual Analytics

2024.09

2024.03

The Visual Analytics API provides simplified ways to perform basic tasks with reports.  Tasks include exporting a report as a PDF file, or as a package file, or exporting an image of a part of the report.

Delete the job information. This operation is specific to the case of asynchronous execution of a report action job.  If the job is still running, attempt to cancel it. This does not attempt to delete result files that reside under control of other services.

jobId

Successfully deleted. Nothing to be returned.

Location

This is an example of Bad request GET export data call


Error

application/vnd.sas.error

Content-Type

Provided if a location would be meaningful in the error context.

Last-Modified

This is an example of  export data job request


Delete the job with its status and links to results

Operation to add a data source to a report

addDataOperationRequest

Operation reponse for adding a data source to a report

addDataOperationResponse

Representation of an add data operation on a request.

addDataRequest

addObjectOperationRequest

Operation response for adding an object to a report

addObjectOperationResponse

The object and placement of the object in a report. One of either the object property or the reportObject property are required. Both are not allowed.

addObjectRequest

addPageOperationRequest

Operation response for adding a page to a report

addPageOperationResponse

addPageRequest

The standard object for the top level resource of the service.  Contains a list of link objects.

apiList

Operation to apply a data view to a report

applyDataViewOperationRequest

Operation reponse for applying a data view to a report

applyDataViewOperationResponse

Representation of an apply data view operation on a request.

applyDataViewRequest

automatedExplanation

automatedExplanationRequest

barChart

barChartRequest

boxPlot

boxPlotRequest

bubbleChangePlot

bubbleChangePlotRequest

bubblePlot

bubblePlotRequest

butterflyChart

butterflyChartRequest

buttonBar

buttonBarRequest

The category specific details of a category data item.

categoryDataItem

Operation to change a data source on a report

changeDataOperationRequest

Operation reponse for changing a data source on a report

changeDataOperationResponse

Representation of a change data operation on a request.

changeDataRequest

cluster

clusterRequest

comparativeTimeSeriesPlot

comparativeTimeSeriesPlotRequest

containerPlacement

correlationMatrix

correlationMatrixRequest

Timestamp when job began processing.   It is in the standard internet format.

creationTimestamp

crosstab

crosstabRequest

data

dataDrivenContent

dataDrivenContentRequest

An individual item (or column) for a data source.

dataItem

The data mapping for a data view that is not a data join. This property is only applicable when the dataItemConflictResolution property is set to 'dataMapping'. It is not valid to use this manual data item mapping when the data view is a data join.

dataMappingObject

dataRoles

dotPlot

dotPlotRequest

dropdownList

dropdownListRequest

dualAxisBarChart

dualAxisBarChartRequest

dualAxisBarLineChart

dualAxisBarLineChartRequest

dualAxisLineChart

dualAxisLineChartRequest

dualAxisTimeSeriesPlot

dualAxisTimeSeriesPlotRequest

Depending on whether the job stopped or is still running, the meaning varies. If the job completed, it is the time at which the job stopped. If the job is still running, it is the time at which the job is stopped, calculated from the time of the original export request and the value of the "timeout" duration. It is in the standard internet format.

endTimestamp

An object representing a job that is run asynchronously for this service.

exportDataJob

Options for generating and downloading a data file in one of several formats. Supported formats are csv, tsv and xlsx. 

exportDataOptions

Information about visual element data that is to be exported. The reportObject property is required to export information about the underlying data. <p> If the folder is not specified, the package is retained for a time, but will not be visible in file selection windows, such as in SAS Drive. It is cached temporarily by the Report Data service for a period of time sufficient for clients to check the status of the package job and download it.

exportDataRequest

exportImageJob

The links to get further status or results of the image export job. The expected link relations are "self", "delete", "result". The `self` link is used to requery the state of the running job. The result link is present only if the job completed and produced a result file that can be downloaded.

exportImageJobLinks

exportImageOptions

Information about the image that is to be exported. It is to be determined whether the entire body is optional, since in the first iteration of this operation, defaults can be supplied by the system for all of the fields.  If an empty body is supplied in the request, a representative normal layout image of the default size is rendered of the first page of the report. The report is saved with a generated name in the personal folder of the caller's identity.

exportImageRequest

The links to get further status or results of the export job.  The expected link relations are "self", "delete", "result", and "deleteContent". The `self` link is used to requery the state of the running job. The result link is present only if the job completed and produced a result file that can be downloaded. The "deleteContent" is present only if result content is deletable by the client.

exportJobLinks

exportPackageJob

Information about package that is to be exported. The reportObjects property can be used to reduce the size of the resulting package. The default is to include all visual elements and pages in the report. <p> If the folder is not specified, the package is retained for a time, but will not be visible in file selection windows, such as in SAS Drive. It is cached temporarily by the Report Packages service for a period of time sufficient for clients to check the status of the package job and download it.

exportPackageRequest

exportPdfJob

Options for executing the action.  May describe output characteristics or control parameters. Not all properties are applicable to every action.

Status	Meaning	Description
204	No Content	Successfully deleted. Nothing to be returned.	Headers
400	Bad Request	There was an error in the request.	Headers	Schema
404	Not Found	Job not found Error		Schema

Delete the job with its status and links to results

Request Samples

Response Samples

Path Parameters

Responses