Export an SVG image of report or report object
Exports an image for the report or part of a report in Scalable Vector Graphics format. The returned content is as specified by the Accept header of the request as "image/svg+xml".
1<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="268" height="151" viewBox="0 0 268 151"> </svg>
| Name | Type | Required | Description |
|---|---|---|---|
reportId | string | true | Identifier of an existing report resource. Report identifiers are generated by the Reports API when reports are created. |
| Name | Type | Required | Description |
|---|---|---|---|
reportObject | string | false | The name of the report object to render in the image. If this is left empty, the image is a representative output from the first page of the report. Report objects include visual elements like graphs, tables, and visual containers that the author has created in the layout, as well as complete pages. Specifying the object by its label makes it more convenient for the report author or viewer and does not to expose the internal names of objects in the model. However, if the client knows the internal identifier of a report object, it can be used instead of the label. |
wait | integer | false | The number of seconds to wait for an update before returning from the "long poll". After this duration has passed, the API returns an HTTP status of 303 to the client with a redirect back to the service so that polling can continue. A system-imposed limit might reduce this requested value. It ranges from 1-60, default to 30. Default: 30 |
size | string | true | Size of the resulting image in the form "9999px,9999px", where the horizontal dimension is before the comma and the vertical dimension is afterward. The two characters after the digits are reserved for unit specifiers; for example, "1024px,768px". The only units currently supported are pixels ("px") but the unit must be specified. This parameter must be specified. Match pattern: /[0-9]{2,6}px[\,][0-9]{2,6}px/ |
| Name | Type | Required | Description |
|---|---|---|---|
Accept-Language | string | false | The user's language, which is used in both rendering and caching. For technical details, see "/tools.ietf.org/html/rfc7231#section-5.3.5" It affects the language of reports if they have been translated. This setting overrides any other user preference that has been set, such as the "offline process locale" preference in Visual Analytics. If this header is not set and there is no user preference, the language is the default language of the service. |
Accept-Locale | string | false | A "format locale" that is distinct from the user's language (Accept-Language). Its syntax is similar to Accept-Language. It is honored in running of queries and formatting of values. This setting overrides any other user preference that has been set, such as the "regional locale for formats" preference in Visual Analytics. If this header is not set and there is no user preference, the format locale is the default locale of the service. |
| Status | Meaning | Description | ||
|---|---|---|---|---|
| 200 | OK | The image been created and is returned as the response body. | Headers | Schema |
| 303 | See Other | The operation could not be completed before the wait period expired. This redirect (See Other) continues the process of waiting for the result. It is used to provide liveness to the browser transmit queue. Note that although this practice of redirecting is common, clients that cannot follow a redirect must either not use this method or specify a longer | Headers | Schema |
| 400 | Bad Request | There was an error in the request. | Headers | Schema |
| 403 | Forbidden | The user did not have the necessary permissions. | Schema | |
| 404 | Not Found | No report exists at the requested path. | Schema |