Overview
There are two ways to retrieve data from Orgvue via the API
Raw data can be retrieved from the items endpoint, while full data (including calculated properties and linked data) can be fetched via the Export Endpoint
Feature guide
Use the information in the following table to decide which API functionality to use for your needs.
| Feature | Retrieve items | Export dataset |
|---|---|---|
| Data egress from Orgvue | Yes | Yes |
| Calculated properties | No | Yes |
| Output to secure file | No | Yes |
| Output in response payload | Yes | Yes |
| Filter records | On raw data | After calculations |
| Specify columns | Yes | Yes |
| Speed | Optimal | Calculation dependent |
Filtering
Both the export dataset and retrieve items capabilities support filtering of records. However, there is one important distinction; the filtering of items happens as they are being retrieved, and thus can drastically reduce the request duration. At the same time, this filter does not support internal or calculated properties (these properties not being available on raw items). In the case of export, calculations must be run on the dataset as a whole before the filter is applied. Filtering therefore may not significantly impact request latency.