πŸ“‘What Metadata is Stored

Learn what metadata is held by default in content entries and is available for you to query.

Aside from metadata you add to each individual content entry, you are also able to query for metadata automatically generated by the platform for each individual content entry.

Different asset types and target types can determine the automatically generated metadata available.

Any Content Entry

These metadata keys are available for any content entry regardless of the asset type or target type.

Key

Type

Description

Value Example

createdAt

Number

Timestamp in UTC format of the time the content was created

1587258208433

lastAccessed

Number

Timestamp in UTC format of the last time the content was accessed

1587248667634

accessHistory

Array

A collection of timestamps in UTC format of the times the content was accessed

[\"1587253222904\"]

usageByDate

Object

A collection of dates in human readable format in which the content was used and a counter of the overall time it was used.

[{\"date\":\"2020-04-18\",\"numUses\":12.0}]

qrWebXRStorageFilename

String

Filename of a QR image redirecting to a sample WebXR experience that shows this asset

qr_webxr_my_key_1234.png

qrWebXRStorageID

String

Storage ID of a QR image redirecting to a sample WebXR experience that uses this asset

9d39d3f4-68f5-49ae-a798-903ac249f073

qrARjsStorageFilename

String

Filename of a QR image redirecting to a sample AR.js experience that shows this asset

qr_arjs_my_key_1234.png

qrARjsStorageID

String

Storage ID of a QR image redirecting to a sample AR.js experience that shows this asset

fd3f4c85-5d47-40ea-a38c-9aeb728f780b

qrARjsTargetStorageFilename

String

Filename of the target file used for a sample AR.js experience that shows this asset

qr_arjs_my_key_1234.patt

qrARjsTargetStorageID

String

Storage ID of the target file used for a sample AR.js experience that shows this asset

ce090285-8b88-4b12-b9d3-da6490298da2

qrARjsMarkerStorageFilename

String

Filename of the image marker file used for a sample AR.js experience that shows this asset

marker_qr_arjs_my_key_1234.png

qrARjsMarkerStorageID

String

Storage ID of a QR image redirecting to a sample AR.js experience that uses this asset and doubles as a marker

bb9e8709-a882-49fe-a3d1-9804fa452ba4

source

String

Credit attribution to the creator of the asset

Skyscraper by Poly by Google, CC-BY

Specific Asset Types

These metadata keys are available for content entries with specific asset types.

Model Assets

Key

Type

Description

Value Example

glbHologramStorageFilename

String

Filename of a .glb version of the 3D model, if such exists

Skyscraper.glb

glbHologramStorageID

String

Storage ID of a .glb version of the 3D model, if such exists.

d686a655-e800-430d-bfd2-e38cdfb0c9e9.glb

usdzHologramStorageFilename

String

Filename of a .usdz version of the 3D model, if such exists

Skyscraper.usdz

usdzHologramStorageID

String

Storage ID of a .usdz version of the 3D model, if such exists.

d686a655-e800-430d-bfd2-e38cdfb0c9e9.usdz

vuforiaHologramStorageFilename

String

Filename of a .h version of the 3D model, if such exists

Skyscraper.h

vuforiaHologramStorageID

String

Storage ID of a .h version of the 3D model, if such exists.

7068cd74-6c9f-4106-9326-585c56fa4475

shortURL

String

A short shareable URL which automatically redirects to the model

https://go.echo3d.co/24m3

Video Assets

Key

Type

Description

Value Example

height

Number

Height of the video frame

360

width

Number

Width of the video frame

460

Image Assets

Key

Type

Description

Value Example

height

Number

Height of the video frame

360

width

Number

Width of the video frame

460

compressedImageStorageID

String

Storage ID of the compressed version of the image uploaded by the user, if such exists.

d2c42d32-dd13-4541-b446-89dcf8e4bcb4

Specific Target Types

These metadata keys are available for content entries with specific target types.

Surface Targets

No additional metadata for surface targets.

Location Targets

No additional metadata for location targets.

Image Targets

Key

Type

Description

Value Example

originalImageStorageID

String

Storage ID of the original image uploaded by the user before being compressed, if such exists.

d2c42d32-dd13-4541-b446-89dcf8e4bcb4

arjsTargetStorageFilename

String

Filename of the target file used for a sample AR.js experience that shows this asset

air.patt

arjsTargetStorageID

String

Storage name of the target file used for a sample AR.js experience that shows this asset

f6607f7b-aee2-4cc8-87e1-97be5a6c36a6

arcoreTargetStorageFilename

String

Filename of the target file used for a sample AR.js experience that shows this asset

air.imgdb

arcoreTargetStorageID

String

Storage ID of the target file used for a sample AR.js experience that shows this asset

420c746a-34e3-4535-b9ba-a4c14b4cc881

arjsMarkerStorageFilename

String

Filename of the image marker file used for a sample AR.js experience that shows this asset

marker_air.png

arjsMarkerStorageID

String

Storage ID of the image marker file used for a sample AR.js experience that shows this asset

440c117a-5b11-4380-8d1d-6d54d3889c08

vuforiaTargetID

String

Target ID of the image used by Vuforia Cloud Recognition

6309204a74d842a8b 6917e6aef743088

Last updated