Export Design Elements

get

https://{workspace}.api.vitruvi.cc/api/v1/reporting/design_elements_export/

Export Vitruvi data for use in system integrations, client backups and reporting.

Query Params

fields

string

A comma-delimited list of fields that should be returned in the API call. If the fields parameter is omitted or empty, all fields will be returned.

If any of the fields listed in the fields parameter do not exist, these fields will be ignored and only the fields that do exist in the dataset will be returned. No error will be raised if field names are included that do not exist in the data set.

filter_expression

string

Additional filter criteria including column names, functions and operators.

For a complete description of filtering using filter expression, see Filter Expressions.

limit

integer

Defaults to 1000

The number of records returned in the single call. See API Paging.

offset

integer

Defaults to 0

The number of records to skip. The offset value is usually equal to the page_number * limit. See API Paging.

ordering

string

The name of the fields to order the results by. Multiple columns can be specified as a comma separated list (i.e. id,name). Columns can also be ordered in descending order by prefixing with a hyphen (i.e. -id).

string

A search term.

Response

Language

Credentials

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200