Getting a Document as a ZIP file

Usage
Returns a ZIP file that archives the document reports of your choice as HTML files.
Note
  • You create the ZIP file by calling POST /documents/<documentID>/zips?reportIds=<reportID[,...]>.
  • You can export a document with all of its reports as a ZIP file by calling GET /documents/<documentID>?fileName=<fileName>.
  • Exports to HTML will be optimized for the end-user browser if you use the User-Agent HTTP header in the REST API call.
Request

GET /documents/<documentID>/zips/<zipID>?fileName=<fileName>

Where:

  • <fileName> is a string that defines the name of the ZIP file. Maximum string length is 96.

    This parameter is optional. If set, the HTML output is zipped in a fileName.zip file and sent as attachment.

Response

Response type: application/zip

Response: the document as a ZIP file.

Example

GET /documents/14746/zips/0?fileName=myZipFile