API Base URL: https://api-platform.vntana.com
For a collection of all Endpoints in our Admin API, view the documentation here. To view the collection of Public Endpoints, view the documentation here. Note: In the following guide and aforementioned documentation, you will see referenced in numerous Endpoints something called a Client. This refers to the folders one can create on the Platform within an Organization. The Client nomenclature is a legacy reference being replaced with Folder. These will be referenced as Client / Folder in all guides.
Report Generation Endpoint
The VNTANA Metadata App allows for the quick generation of reports containing various data about your Assets on the Platform. This is accomplished via API calls which can be utilized on their own and can be directly integrated into any pipeline. For generating pipelines, there is a single endpoint that needs to be called:
-
type – [required] Indicates what filetype the data should be returned as, options are
[CSV, XLSX]. -
clientsUuids – [required] Indicates which Workspaces the data should be collected from.
-
requestColumns – [required] A list of all pieces of information that should be included in the sheet. Leave empty to include everything. See below for the full list of all options.
-
includeColumnHeaders – [optional] Indicates whether a header row should be included. Default true.
-
oneSheetPerWorkspace – [optional] Indicates whether Workspaces should be separated into their own sheets. Only applicable if type is set to
XLSX. Default false. -
async – [optional] Indicates whether the request is async or not. This allows for monitoring the request, see below on checking the status of a report request.
A successful request will return the following data:
signedUrl parameter which can be used to download the newly generated report. It also identifies the generationUuid which can be used to track the status of the report generation if async was set to true. Report Product Attributes
As shown above, the request takes a parameter called requestedColumns which is a list containing all data fields that should be returned in the report. The list of all options covers most pieces of information about an Asset, with some having specific behaviors to consider when generating. One key point to note on generating reports, the data that is returned is always Asset centric, meaning each row always corresponds to an Asset on the Platform.
| Attribute | Description | Notes |
|---|---|---|
| PRODUCT_NAME | Simply the name of an Asset | |
| PRODUCT_UUID | The UUID of an Asset | |
| PRODUCT_STATUS | The conversion status of an Asset | LIVE_PUBLIC, LIVE_INTERNAL, DRAFT, FAILED, TERMINATED |
| PRODUCT_ASSET_TYPE | The type of the Asset | Indicates whether the asset is a 3D Asset, image, video, avatar, etc. |
| PRODUCT_ORIGINAL_FILE_NAME | The name of the original file that was uploaded. This may be the same as the Asset Name. | |
| PRODUCT_WORKSPACE_NAME | The name of the Workspace this Asset is contained within. | |
| PRODUCT_WORKSPACE_SLUG | The slug of the Workspace containing the Asset. | This is a unique identifier for the Workspace, based on the original name of the Workspace. While it is possible to rename a Workspace, this slug will always remain the same. |
| PRODUCT_WORKSPACE_UUID | The UUID of the Workspace containing the Asset. | Another unique identifier for the Workspace, this id will never change. |
| PRODUCT_EMBED_LINK | The Embed Link of an Asset for sharing. | |
| PRODUCT_DESCRIPTION | The description of an Asset, if it has one. | |
| PRODUCT_TAGS | All tags applied to an Asset. | Due to the nature of tags not having any kind of ‘groupable' identifier, the tags will be returned in a single column with each row containing a list of each tag on the Asset. i.e. tag1|tag2|tag3. |
| PRODUCT_ATTRIBUTES | All attributes on an Asset. | Attributes are a unique case in the possible items that can be returned. Due to the Showrooms feature, attributes exist on the Organization level, so selecting this option will provide a column for each attribute in the Organization, filling in individual rows based on whether the Asset in question has a value for that attribute. The column header will be the key of the attribute with the row value being the attribute value. |
| PRODUCT_PROJECT_UUID | A list of Project UUIDs the Asset is a part of. | Returns only direct Project links, no sub-projects or parent-projects. May return multiple UUID’s if the Asset is linked to multiple, the value will be uuid1|uuid2|uuid3. |
| PRODUCT_PROJECT_NAME | A list of Project Names the Asset is a part of. | Same as the Project UUID’s, only direct links with values like name1|name2|name3. |
| ORIGINAL_FILE_SIZE | The original size of the uploaded File in MB. | |
| OPTIMIZED_FILE_SIZE | The file size of the Optimized Assets. | Will return columns for each optimized file type, GLB, USDZ, FBX. |
| ORIGINAL_POLY_COUNT | The original poly count of the uploaded File. | |
| OPTIMIZED_POLY_COUNT | The poly count of each optimized version. | Returns counts for the GLB, USDZ, and FBX. |
| ORIGINAL_VERTEX_COUNT | The original vertex count of the uploaded File. | |
| OPTIMIZED_VERTEX_COUNT | The vertex count of each optimized version. | Returns counts for the GLB, USDZ, and FBX. |
| OPTIMIZATION_PRESET | The UUID and Name of the Optimization Preset applied to the Asset, if applicable. | Returned in the format uuid|name. |
| VIEWER_PRESET | The UUID and Name of the Viewer Preset applied to the Asset, if applicable. | Returned in the format uuid|name. |
| PRODUCT_CREATED_DATE | The timestamp of when the Asset was created. | |
| PRODUCT_UPDATED_DATE | The timestamp of when the Asset was last updated. | |
| AMAZON_PUBLISH_STATUS | Returns the individual publish status for each Amazon marketplace linked to the Organization. | If you have added the stores United States and Canada to your Organization, this value will return the columns Amazon Integration - United States and Amazon Integration - Canada with the publish status of the asset for each. |
| AMAZON_ASINS | Returns the ASINs applied to an Asset per Amazon marketplace. | If you have added the stores United States and Canada to your Organization, this will return the columns Amazon Integration - United States ASINs and Amazon Integration - Canada ASINs. The value of the rows will simply be the ASIN. |
| ASSET_DIMENSIONS | Returns the dimensions in centimeters of the Assets bounding box. | This is currently only used for the Amazon Integration. |
Checking the Status of a Report
If the async option is used (set to true) when generating a report, the status can be checked using the following endpoint:
This uses the generationUuid returned in the response of the generation request to identify the report when getting the status. A successful request will return the following response:
The response is the same response found from the regular request, with the signedUrl value allowing you to download the report is the status is COMPLETED.