Export - Returns URL for requested visual

Returns the URL for large visual exports.

post

Authorizations

Bearer

HTTPRequired

Please enter a valid token

Query parameters

versionstringOptional

The requested API version

Default: 1.0

Header parameters

embedfast-user-idstringOptional

Optional User Id

embedfast-user-emailstringOptional

Optional User Email

Body

application/jsontext/jsonapplication/*+json

Class for visual export request.

exportTypestring | nullableOptional

Export format file type.

reportPageNamestring | nullableOptional

Page name of the report which contains the visual.

userNamestring | nullableOptional

User name of the user creating the request.

userIdstring · uuidOptional

User id of the user creating the request.

assetIdstring · uuidOptional

Asset id of the report which contains the visual.

Responses

200

Success: Returns the SAS URL for the requested visual export.

text/plainapplication/jsontext/json

Responsestring

400

Bad Request: The request could not be processed due to invalid syntax or missing/incorrect parameters.

text/plainapplication/jsontext/json

401

Unauthorized: Invalid credentials or missing/invalid authentication token.

text/plainapplication/jsontext/json

404

Not Found: The requested resource was not found, the URL is invalid, or the resource has been deleted.

text/plainapplication/jsontext/json

500

Internal Server Error: An unexpected error occurred or a server timeout.

text/plainapplication/jsontext/json

post

/visualExport

HTTPcURLJavaScriptPython

POST /visualExport HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 893

{
  "exportType": "text",
  "reportPageName": "text",
  "userName": "text",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "assetId": "123e4567-e89b-12d3-a456-426614174000",
  "visualData": [
    {
      "datasetName": "text",
      "tenantId": "text",
      "datasetId": "text",
      "schema": {
        "tables": [
          {
            "tableName": "text",
            "columns": [
              "text"
            ],
            "measures": [
              "text"
            ]
          }
        ],
        "filters": [
          {
            "target": {
              "tableName": "text",
              "column": "text",
              "measure": "text",
              "aggregationFunction": "text"
            },
            "values": [
              "text"
            ],
            "filterType": 1,
            "orderBy": {
              "tableName": "text",
              "column": "text",
              "measure": "text",
              "aggregationFunction": "text"
            },
            "operator": "text",
            "logicalOperator": "text",
            "conditions": [
              {
                "operator": "text",
                "value": null
              }
            ],
            "itemCount": 1,
            "includeToday": true,
            "operatorRelative": 1,
            "timeUnitType": 1,
            "timeUnitCount": 1
          }
        ]
      },
      "visibleColumns": [
        {
          "tableName": "text",
          "column": "text",
          "measure": "text",
          "aggregationFunction": "text"
        }
      ],
      "visualName": "text",
      "visualTitle": "text",
      "tenantName": "text"
    }
  ]
}

application/jsontext/jsonapplication/*+json

text