echo3D
🌐 Back to website💻 Go to console📺 Watch workshop💬 Discuss on Slack
  • Introduction
  • Quickstart
    • 🔑Register
    • 💻Access the Console
    • 🎲Add a 3D Asset
    • 📤Share it with Others
    • ❔Troubleshooting
  • Web Console
    • 📦Load a Collection
    • 💼Manage Pages
      • Content Page
        • Assets and Targets
        • Add Content
        • Edit Content
        • Share Content
        • Access Permissions
        • Version Control
        • Asset Hierarchy
        • Bulk Actions on Assets
        • Asset Commenting
        • Activity Sidebar
      • Metadata & Tags Page
        • Collection Taxonomy and Asset Specific Metadata
        • How to Add and Edit Metadata
        • How to Add Associated Files and Text
      • Collections and Sharing Page
        • Users Tab
        • Groups Tab
        • Collections
        • Collection Sharing Tab
        • Asset Sharing Tab
        • Security Tab
      • Customizer Page
      • Model Editor Page
      • Scene Editor Page
    • 🚚Deliver Pages
      • Locations Page
      • Users Page
      • Insights Page
    • 🕛Optimize Pages
      • Convert & Compress Page
    • 🎓Learn Pages
      • Tutorials Page
    • 👤Account Page
      • Profile Tab
      • Email & Password
      • Plans Tab
      • Credit Usage Tab
      • Notifications Tab
      • Delete Account Tab
    • ❓Help Menu
    • ⏬Downloads
    • 🎨Themes
    • 🔎Search
  • API
    • 🧩Objects
    • 🗨️Queries
    • 📊Data
      • 📑What Metadata is Stored
    • 🔼Upload
    • 🔽Download
    • ❌Delete
    • 🌳Entry Hierarchy
    • 🔄Convert
    • 🔃Compress
    • 📁Organize
    • ⏪Version
    • ⏬Locate
    • 🔎Search
    • 🖼️Search by Image or Model
    • Share Content
  • Unity
    • 🔨Installation
    • 🧰Using the SDK
    • 🔧Script Settings
    • 📐Transforming Content
    • 👩‍💻Edit Code
    • 🤳Adding AR Capabilities
    • ❔Troubleshooting
  • Unreal 4
    • 🔨Installation
    • 🧰Using the SDK
    • 🔧Demo Project
  • Web
    • 🔨Installation
    • 🧰Using the Package
  • Scene Viewer
    • 📲Deploy Experience
    • 📐Transforming Content
    • 🔢Embed into Website or App
    • 👩‍💻Add Code
    • ❔Troubleshooting
  • AR.js
    • 📲Deploy Experience
    • 📐Transforming Content
    • 🔢Embed into Website or App
    • ❔Troubleshooting
  • FaceAR
    • 📲Deploy Experience
    • 📐Transforming Content
    • 🔢Embed into Website or App
    • ❔Troubleshooting
  • React Native
    • 📩Fetching Data
    • 👩‍💻Edit Code
    • 🤳Adding AR/VR Capabilities
    • 📐Transforming Content
  • Swift
    • 🔨Installation
    • 🔢Displaying a Model Asset
    • 🤳Adding AR Capabilities
    • 🧰Using the SDK
  • Flutter
    • 🔨Installation
    • 👩‍💻Edit Code
    • 🤳Adding AR Capabilities
  • JavaScript
    • 🔨Installation
    • 🧰Using the SDK
    • 📩Fetching Data
    • 👩‍💻Edit Code
  • Python
    • 🔨Installation
    • 🧰Using the SDK
    • 🔧Demo Project
  • NVIDIA Omniverse
    • 🔨Installation
  • Adobe Substance 3D Painter
    • 🔨Installation
  • 🧰Using the Plugin
  • Blender
    • 🔨Installation
    • 🧰Using the Add-on
  • eCommerce Sites
    • 🛒Shopify
    • 🌐Wix
  • 3D Content
    • 🎨Content Creation
    • 💎Google Poly
    • 📦Objaverse
    • 💫3D Capture Apps
      • MagiScan
      • Qlone
      • ARitize360
      • SCANN3D
      • 3D Scanner
      • Didimo Xperience
      • Scaniverse
      • Metascan3D
      • Polycam3D
      • RealityScan
Powered by GitBook
On this page
  • Get a global data entry
  • Post a global data entry
  • Delete global data entry
  • Get metadata of an entry
  • Post metadata to an entry
  • Delete metadata from an entry
  • Post metadata to a few entries with the same data name at the same time
  • Query the number of clicks received by custom buttons for WebAR

Was this helpful?

  1. API

Data

Learn how to post data to the project.

Get a global data entry

GET https://api.echo3D.com/get?key=<API_KEY>&data=<DATA>

This query allows you to get global data entries.

Query Parameters

Name
Type
Description

key*

string

Your API key.

data*

string

A data key, e.g. scale.

email*

string

Your email address

userKey*

string

Your authentication key

secKey

string

<VALUE>
Invalid request! No data value found in request.
Data not found

Post a global data entry

POST https://api.echo3D.com/post?key=<API_KEY>&data=<DATA>&value=<VALUE>

This query allows you to add a global data entry.

Query Parameters

Name
Type
Description

key*

string

The API key.

data*

string

A data key, e.g. scale.

value*

string

A data value, e.g. 2.

email*

string

Your email address

userKey*

string

Your authentication key

secKey

string

<VALUE>
Invalid request! No data value found in request.

Delete global data entry

POST https://api.echo3d.com/remove?key=<API_KEY>&data=<DATA>&email=<EMAIL>

This query allows you to remove a global data entry.

Request Body

Name
Type
Description

key*

string

Your API key

data*

string

A data key, e.g. scale.

email*

string

Your email address

userKey*

string

Your authentication key

secKey

string

Get metadata of an entry

GET https://api.echo3D.com/get?key=<API_KEY>&entry=<ENTRY>&data=<DATA>

The query allows you to get metadata of a specific entry. You can either query for a specific data key or for all the data associated with the entry.

Query Parameters

Name
Type
Description

key*

string

Your API key.

entry*

string

A specific entry ID.

data*

string

A data key, e.g. scale.

email*

string

Your email address

userKey*

string

Your authentication key

secKey

string

{
    "<KEY_1>": "<VALUE_1>",
    "<KEY_2>": "<VALUE_2>",
    "<KEY_3>": "<VALUE_3>",
    ...
}
<VALUE>
Invalid request! No data value found in request.
Data not found

Post metadata to an entry

POST https://api.echo3D.com/post?key=<API_KEY>&entry=<ENTRY>&data=<DATA>&value=<VALUE>

This query allows you to add metadata to a specific entry.

Query Parameters

Name
Type
Description

key*

string

Your API key

entry*

string

A specific entry ID.

data*

string

A data key, e.g. scale.

value*

string

A data value, e.g. 2.

email*

string

Your email address

userKey*

string

Your authentication key

secKey

string

Additional data <DATA,VALUE> updated in entry <ENTRY>.
Invalid request! No data value found in request.

Delete metadata from an entry

POST https://api.echo3d.com/remove?key=<API_KEY>&entry=<ENTRY>&data=<DATA>&email=<EMAIL>

This query allows you to remove metadata to a specific entry.

Request Body

Name
Type
Description

key*

string

Your API key

entry*

string

A specific entry ID.

data*

string

A data key, e.g. scale.

email*

string

Your email address

userKey*

string

Your authentication key

secKey

string

Additional data key <data> removed in entry <entry>
Invalid request! 

Post metadata to a few entries with the same data name at the same time

POST https://api.echo3d.com/batchpost?key=<API_KEY>&entries=<ENTRY_IDs>&data=<DATA>&value<ENTRY_VALUES>

You can set a few entries with the same data name together, even if they have a different value

Request Body

Name
Type
Description

key*

string

Your API key

entries*

string

A list of entries to update, separated by a comma (',')

data*

string

A data key, e.g. scale.

value*

string

A list of data values, corresponding with the entry IDs, separated by a comma (','). e.g. 2,5,1. Your number of values must be the same as the number of entries you wish to update.

email*

string

Your email address

userKey*

string

Your authentication key

secKey

string

Query the number of clicks received by custom buttons for WebAR

GET https://api.echo3D.com/query?key=<API_KEY>&webARButtonClick=true

Request Body

Name
Type
Description

key*

string

Your API key

webARButtonClick*

string

true, to get the number of clicks

email*

string

Your email address

userKey*

string

Your authentication key

secKey

string

{
  "topLeftClickCounter": 0,
  "bottomRightClickCounter": 0,
  "centerClickCounter": 0,
  "rightClickCounter": 0,
  "topRightClickCounter": 0,
  "bottomClickCounter": 0,
  "bottomLeftClickCounter": 0,
  "leftClickCounter": 0,
  "topClickCounter": 0
}
Key <API_KEY> not found!

PreviousQueriesNextWhat Metadata is Stored

Last updated 3 months ago

Was this helpful?

Your Secret key. Only if enabled through the .

Your Secret key. Only if enabled through the .

Your Secret key. Only if enabled through the

Your Secret key. Only if enabled through the .

Your Secret key. Only if enabled through the .

Your Secret key. Only if enabled through the

Your Secret key. Only if enabled through the

Your Secret key. Only if enabled through the .

📊
Security page
Security page
Security page
Security page
Security page
Security page
Security page
Security page