View.Export
  • 07 Apr 2025
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

View.Export

  • Dark
    Light
  • PDF

Article summary

Description

Allows users to export a view.

URL parameters

URL parameter ordering

The URL parameters below are listed in the order they should be entered in the API URL.

NameRequiredTypeDescription
ViewIDTruenumericUnique identifier of the view.
FileFormatFalsestringCSV, TSV, XML, JSON, and XLSX. Default is CSV.
CollectionIDFalsenumericUnique identifier of the collection. REQUIRED if the view is a shared view in an agent group.
ViewParameter.JobIDFalsestringThe JobID that you want the items pulled from.
ViewParameter.<ParameterName>FalsestringUsed for dynamic view criteria. E.g. criterion:Name Equals %NameValue% can be set with ViewParameter.NameValue=Michael.
ItemStatusInclueColumnFalsebooleanYes, NoYes to include the column in the data file. Default is No. See additional options below.

Optional parameters for ItemStatusInclude

NameRequiredTypeDescription
ItemStatusIncludeAddedFalsebooleanYes, No. Include added items.
ItemStatusIncludeChangedFalsebooleanYes, No. Include changed items.
ItemStatusIncludeUnchangedFalsebooleanYes, No. Include unchanged items.
ItemStatusIncludeDeletedFalsebooleanYes, No. Include deleted items.
ItemStatusIncludeChangeMarkupFalsebooleanYes, No. Include a column with the changed markup.

Responses

Automatically download the file for the selected view.

Sample request

curl -X GET 'https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=View.Export&ViewID=153888

Was this article helpful?