👁️‍🗨️Queries

Learn how to query for information on the entries of the project.

Get entries

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

This query allows you to retrieve a data set of entries associated with your API key.

Query Parameters

{
  "apiKey": "<API_KEY>",
  "db": {
    "b02cc2f0-3050-4f3a-999e-c8e8be9d3b5b": {
      "id": "b02cc2f0-3050-4f3a-999e-c8e8be9d3b5b",
      "target": {
        "id": "df54c477-8eeb-4530-b989-4cb3cdcd6512",
        "type": "BRICK_TARGET",
        "holograms": [
          "ada1dfd6-0f0e-4606-bde6-fc88a0610466"
        ]
      },
      "hologram": {
        "filename": "Skyscraper.obj",
        "storageID": "d686a655-e800-430d-bfd2-e38cdfb0c9e9",
        "textureFilenames": [
          "Skyscraper_BaseColor.png"
        ],
        "textureStorageIDs": [
          "f9b43711-cf79-44e5-90c5-ac781c8d9288"
        ],
        "materialFilename": "Skyscraper.mtl",
        "materialStorageID": "891d0b32-4f4b-4f7d-a2e2-d5922611928d",
        "id": "ada1dfd6-0f0e-4606-bde6-fc88a0610466",
        "type": "MODEL_HOLOGRAM",
        "targetID": "df54c477-8eeb-4530-b989-4cb3cdcd6512"
      },
      "sdks": [
        true,
        true,
        false,
        true,
        false,
        false,
        false,
        true,
        true
      ],
      "additionalData": {
        "qrWebXRStorageID": "018b9e20-3b8e-47f8-a19c-eca8dde46137",
        "vuforiaHologramStorageID": "7068cd74-6c9f-4106-9326-585c56fa4475",
        "glbHologramStorageID": "d686a655-e800-430d-bfd2-e38cdfb0c9e9.glb",
        "source": "Skyscraper by Poly by Google, CC-BY, https://poly.google.com/view/dIsZyy2FUY-",
        "qrARjsTargetStorageID": "e7f058d5-5b66-4f50-8cdd-89f057e8070c",
        "qrARjsStorageID": "7cc6adca-ded1-4a46-a289-c07c07cb2f5c",
        "vuforiaHologramStorageFilename": "Skyscraper.h",
        "qrARjsMarkerStorageID": "5de99f4d-9602-45f0-b5ce-7ef53541cb18",
        "glbHologramStorageFilename": "Skyscraper.glb"
      }
    }
  }
}

Key '<API_KEY>' not found!

Get a specific entry

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

This query allows you to retrieve a specific entry.

Query Parameters

{
  "apiKey": "<API_KEY>",
  "db": {
    "b02cc2f0-3050-4f3a-999e-c8e8be9d3b5b": {
      "id": "b02cc2f0-3050-4f3a-999e-c8e8be9d3b5b",
      "target": {
        "id": "df54c477-8eeb-4530-b989-4cb3cdcd6512",
        "type": "BRICK_TARGET",
        "holograms": [
          "ada1dfd6-0f0e-4606-bde6-fc88a0610466"
        ]
      },
      "hologram": {
        "filename": "Skyscraper.obj",
        "storageID": "d686a655-e800-430d-bfd2-e38cdfb0c9e9",
        "textureFilenames": [
          "Skyscraper_BaseColor.png"
        ],
        "textureStorageIDs": [
          "f9b43711-cf79-44e5-90c5-ac781c8d9288"
        ],
        "materialFilename": "Skyscraper.mtl",
        "materialStorageID": "891d0b32-4f4b-4f7d-a2e2-d5922611928d",
        "id": "ada1dfd6-0f0e-4606-bde6-fc88a0610466",
        "type": "MODEL_HOLOGRAM",
        "targetID": "df54c477-8eeb-4530-b989-4cb3cdcd6512"
      },
      "sdks": [
        true,
        true,
        false,
        true,
        false,
        false,
        false,
        true,
        true
      ],
      "additionalData": {
        "qrWebXRStorageID": "018b9e20-3b8e-47f8-a19c-eca8dde46137",
        "vuforiaHologramStorageID": "7068cd74-6c9f-4106-9326-585c56fa4475",
        "glbHologramStorageID": "d686a655-e800-430d-bfd2-e38cdfb0c9e9.glb",
        "source": "Skyscraper by Poly by Google, CC-BY, https://poly.google.com/view/dIsZyy2FUY-",
        "qrARjsTargetStorageID": "e7f058d5-5b66-4f50-8cdd-89f057e8070c",
        "qrARjsStorageID": "7cc6adca-ded1-4a46-a289-c07c07cb2f5c",
        "vuforiaHologramStorageFilename": "Skyscraper.h",
        "qrARjsMarkerStorageID": "5de99f4d-9602-45f0-b5ce-7ef53541cb18",
        "glbHologramStorageFilename": "Skyscraper.glb"
      }
    }
  }
}

Entry ID '<ENTRY_ID>' not associated with key '<API_KEY>'.

Get specific entries

GET https://api.echo3D.com/query?key=<API_KEY>&entries=<ENTRY_ID1>,<ENTRY_ID2>,..

This query allows you to retrieve specific entries.

Query Parameters

{
  "apiKey": "<API_KEY>",
  "db": {
    "b02cc2f0-3050-4f3a-999e-c8e8be9d3b5b": {
      "id": "b02cc2f0-3050-4f3a-999e-c8e8be9d3b5b",
      "target": {
        "id": "df54c477-8eeb-4530-b989-4cb3cdcd6512",
        "type": "<TYPE>",
        "holograms": [
          "ada1dfd6-0f0e-4606-bde6-fc88a0610466"
        ]
      },
      "hologram": {
        "filename": "Skyscraper.obj",
        "storageID": "d686a655-e800-430d-bfd2-e38cdfb0c9e9",
        "textureFilenames": [
          "Skyscraper_BaseColor.png"
        ],
        "textureStorageIDs": [
          "f9b43711-cf79-44e5-90c5-ac781c8d9288"
        ],
        "materialFilename": "Skyscraper.mtl",
        "materialStorageID": "891d0b32-4f4b-4f7d-a2e2-d5922611928d",
        "id": "ada1dfd6-0f0e-4606-bde6-fc88a0610466",
        "type": "MODEL_HOLOGRAM",
        "targetID": "df54c477-8eeb-4530-b989-4cb3cdcd6512"
      },
      "sdks": [
        true,
        true,
        false,
        true,
        false,
        false,
        false,
        true,
        true
      ],
      "additionalData": {
        "vuforiaHologramStorageID": "7068cd74-6c9f-4106-9326-585c56fa4475",
        "glbHologramStorageID": "d686a655-e800-430d-bfd2-e38cdfb0c9e9.glb",
        "source": "Skyscraper by Poly by Google, CC-BY, https://poly.google.com/view/dIsZyy2FUY-",
        "qrARjsTargetStorageID": "e7f058d5-5b66-4f50-8cdd-89f057e8070c",
        "qrARjsStorageID": "7cc6adca-ded1-4a46-a289-c07c07cb2f5c",
        "vuforiaHologramStorageFilename": "Skyscraper.h",
        "qrARjsMarkerStorageID": "5de99f4d-9602-45f0-b5ce-7ef53541cb18",
        "glbHologramStorageFilename": "Skyscraper.glb"
      }
    }, "b02cc2f0-3050-4f3a-111e-c8e8b2413b5b": {
      "id": "b02cc2f0-3050-4f3a-999e-c8e8be9d3b5b",
      "target": {
        "id": "df54c477-8eeb-4530-b989-4cb3cdcd6512",
        "type": "<TYPE>",
        "holograms": [
          "ada1dfd6-0f0e-4606-bde6-fc88a0610466"
        ]
      },
      "hologram": {
        "filename": "Skyscraper.obj",
        "storageID": "d686a655-e800-430d-bfd2-e38cdfb0c9e9",
        "textureFilenames": [
          "Skyscraper_BaseColor.png"
        ],
        "textureStorageIDs": [
          "f9b43711-cf79-44e5-90c5-ac781c8d9288"
        ],
        "materialFilename": "Skyscraper.mtl",
        "materialStorageID": "891d0b32-4f4b-4f7d-a2e2-d5922611928d",
        "id": "ada1dfd6-0f0e-4606-bde6-fc88a0610466",
        "type": "MODEL_HOLOGRAM",
        "targetID": "df54c477-8eeb-4530-b989-4cb3cdcd6512"
      },
      "sdks": [
        true,
        true,
        false,
        true,
        false,
        false,
        false,
        true,
        true
      ],
      "additionalData": {
        "vuforiaHologramStorageID": "7068cd74-6c9f-4106-9326-585c56fa4475",
        "glbHologramStorageID": "d686a655-e800-430d-bfd2-e38cdfb0c9e9.glb",
        "source": "Skyscraper by Poly by Google, CC-BY, https://poly.google.com/view/dIsZyy2FUY-",
        "qrARjsTargetStorageID": "e7f058d5-5b66-4f50-8cdd-89f057e8070c",
        "qrARjsStorageID": "7cc6adca-ded1-4a46-a289-c07c07cb2f5c",
        "vuforiaHologramStorageFilename": "Skyscraper.h",
        "qrARjsMarkerStorageID": "5de99f4d-9602-45f0-b5ce-7ef53541cb18",
        "glbHologramStorageFilename": "Skyscraper.glb"
      }
    }
  }
}

Entry ID '<ENTRY_ID1>' not associated with key '<API_KEY>'.

Get entries based on file

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

This query allows you to retrieve entries that contain a specific file.

Query Parameters

{
  "apiKey": "<API_KEY>",
  "db": {
    "b02cc2f0-3050-4f3a-999e-c8e8be9d3b5b": {
      "id": "b02cc2f0-3050-4f3a-999e-c8e8be9d3b5b",
      "target": {
        "id": "df54c477-8eeb-4530-b989-4cb3cdcd6512",
        "type": "BRICK_TARGET",
        "holograms": [
          "ada1dfd6-0f0e-4606-bde6-fc88a0610466"
        ]
      },
      "hologram": {
        "filename": "<FILENAME>",
        "storageID": "d686a655-e800-430d-bfd2-e38cdfb0c9e9",
        "textureFilenames": [
          "Skyscraper_BaseColor.png"
        ],
        "textureStorageIDs": [
          "f9b43711-cf79-44e5-90c5-ac781c8d9288"
        ],
        "materialFilename": "Skyscraper.mtl",
        "materialStorageID": "891d0b32-4f4b-4f7d-a2e2-d5922611928d",
        "id": "ada1dfd6-0f0e-4606-bde6-fc88a0610466",
        "type": "MODEL_HOLOGRAM",
        "targetID": "df54c477-8eeb-4530-b989-4cb3cdcd6512"
      },
      "sdks": [
        true,
        true,
        false,
        true,
        false,
        false,
        false,
        true,
        true
      ],
      "additionalData": {
        "qrWebXRStorageID": "018b9e20-3b8e-47f8-a19c-eca8dde46137",
        "vuforiaHologramStorageID": "7068cd74-6c9f-4106-9326-585c56fa4475",
        "glbHologramStorageID": "d686a655-e800-430d-bfd2-e38cdfb0c9e9.glb",
        "source": "Skyscraper by Poly by Google, CC-BY, https://poly.google.com/view/dIsZyy2FUY-",
        "qrARjsTargetStorageID": "e7f058d5-5b66-4f50-8cdd-89f057e8070c",
        "qrARjsStorageID": "7cc6adca-ded1-4a46-a289-c07c07cb2f5c",
        "vuforiaHologramStorageFilename": "Skyscraper.h",
        "qrARjsMarkerStorageID": "5de99f4d-9602-45f0-b5ce-7ef53541cb18",
        "glbHologramStorageFilename": "Skyscraper.glb"
      }
    }
  }
}

No entries found containing a file named '<FILENAME>' associated with key '<API_KEY>'.

Get entries based on data

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

This query allows you to retrieve entries that contain a specific data key and value.

Query Parameters

{
  "apiKey": "<API_KEY>",
  "db": {
    "b02cc2f0-3050-4f3a-999e-c8e8be9d3b5b": {
      "id": "b02cc2f0-3050-4f3a-999e-c8e8be9d3b5b",
      "target": {
        "id": "df54c477-8eeb-4530-b989-4cb3cdcd6512",
        "type": "BRICK_TARGET",
        "holograms": [
          "ada1dfd6-0f0e-4606-bde6-fc88a0610466"
        ]
      },
      "hologram": {
        "filename": "Skyscraper.obj",
        "storageID": "d686a655-e800-430d-bfd2-e38cdfb0c9e9",
        "textureFilenames": [
          "Skyscraper_BaseColor.png"
        ],
        "textureStorageIDs": [
          "f9b43711-cf79-44e5-90c5-ac781c8d9288"
        ],
        "materialFilename": "Skyscraper.mtl",
        "materialStorageID": "891d0b32-4f4b-4f7d-a2e2-d5922611928d",
        "id": "ada1dfd6-0f0e-4606-bde6-fc88a0610466",
        "type": "MODEL_HOLOGRAM",
        "targetID": "df54c477-8eeb-4530-b989-4cb3cdcd6512"
      },
      "sdks": [
        true,
        true,
        false,
        true,
        false,
        false,
        false,
        true,
        true
      ],
      "additionalData": {
        "<DATA>": "<VALUE>",
        "vuforiaHologramStorageID": "7068cd74-6c9f-4106-9326-585c56fa4475",
        "glbHologramStorageID": "d686a655-e800-430d-bfd2-e38cdfb0c9e9.glb",
        "source": "Skyscraper by Poly by Google, CC-BY, https://poly.google.com/view/dIsZyy2FUY-",
        "qrARjsTargetStorageID": "e7f058d5-5b66-4f50-8cdd-89f057e8070c",
        "qrARjsStorageID": "7cc6adca-ded1-4a46-a289-c07c07cb2f5c",
        "vuforiaHologramStorageFilename": "Skyscraper.h",
        "qrARjsMarkerStorageID": "5de99f4d-9602-45f0-b5ce-7ef53541cb18",
        "glbHologramStorageFilename": "Skyscraper.glb"
      }
    }
  }
}

Entries with <data, value> pair '<DATA>,<VALUE>' not associated with key '<API_KEY>'.

Get entries based on tags

GET https://api.echo3D.com/query?key=<API_KEY>&tags=<TAG1>,<TAG2>,..

This query allows you to retrieve entries based on the default ‘tags’ metadata. This query will return any asset whose 'tags' metadata matches any of the query parameter filters.

Query Parameters

{
  "apiKey": "<API_KEY>",
  "db": {
    "b02cc2f0-3050-4f3a-999e-c8e8be9d3b5b": {
      "id": "b02cc2f0-3050-4f3a-999e-c8e8be9d3b5b",
      "target": {
        "id": "df54c477-8eeb-4530-b989-4cb3cdcd6512",
        "type": "BRICK_TARGET",
        "holograms": [
          "ada1dfd6-0f0e-4606-bde6-fc88a0610466"
        ]
      },
      "hologram": {
        "filename": "Skyscraper.obj",
        "storageID": "d686a655-e800-430d-bfd2-e38cdfb0c9e9",
        "textureFilenames": [
          "Skyscraper_BaseColor.png"
        ],
        "textureStorageIDs": [
          "f9b43711-cf79-44e5-90c5-ac781c8d9288"
        ],
        "materialFilename": "Skyscraper.mtl",
        "materialStorageID": "891d0b32-4f4b-4f7d-a2e2-d5922611928d",
        "id": "ada1dfd6-0f0e-4606-bde6-fc88a0610466",
        "type": "MODEL_HOLOGRAM",
        "targetID": "df54c477-8eeb-4530-b989-4cb3cdcd6512"
      },
      "sdks": [
        true,
        true,
        false,
        true,
        false,
        false,
        false,
        true,
        true
      ],
      "additionalData": {
        "tags": "<TAG1>",
        "vuforiaHologramStorageID": "7068cd74-6c9f-4106-9326-585c56fa4475",
        "glbHologramStorageID": "d686a655-e800-430d-bfd2-e38cdfb0c9e9.glb",
        "source": "Skyscraper by Poly by Google, CC-BY, https://poly.google.com/view/dIsZyy2FUY-",
        "qrARjsTargetStorageID": "e7f058d5-5b66-4f50-8cdd-89f057e8070c",
        "qrARjsStorageID": "7cc6adca-ded1-4a46-a289-c07c07cb2f5c",
        "vuforiaHologramStorageFilename": "Skyscraper.h",
        "qrARjsMarkerStorageID": "5de99f4d-9602-45f0-b5ce-7ef53541cb18",
        "glbHologramStorageFilename": "Skyscraper.glb"
      }
    }
  }
}

{}

Get entries based on filters

GET https://api.echo3D.com/query?key=<key>&filters=<filter1>,<filter2>,<filter3>,...

This query allows you to retrieve entries based on the default ‘tags’ metadata. This query will return any asset whose 'tags' metadata matches all of the query parameter filters.

Query Parameters

Get entries based on type

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

This query allows you to retrieve entries that contain a specific type of hologram or target.

Query Parameters

{
  "apiKey": "<API_KEY>",
  "db": {
    "b02cc2f0-3050-4f3a-999e-c8e8be9d3b5b": {
      "id": "b02cc2f0-3050-4f3a-999e-c8e8be9d3b5b",
      "target": {
        "id": "df54c477-8eeb-4530-b989-4cb3cdcd6512",
        "type": "<TYPE>",
        "holograms": [
          "ada1dfd6-0f0e-4606-bde6-fc88a0610466"
        ]
      },
      "hologram": {
        "filename": "Skyscraper.obj",
        "storageID": "d686a655-e800-430d-bfd2-e38cdfb0c9e9",
        "textureFilenames": [
          "Skyscraper_BaseColor.png"
        ],
        "textureStorageIDs": [
          "f9b43711-cf79-44e5-90c5-ac781c8d9288"
        ],
        "materialFilename": "Skyscraper.mtl",
        "materialStorageID": "891d0b32-4f4b-4f7d-a2e2-d5922611928d",
        "id": "ada1dfd6-0f0e-4606-bde6-fc88a0610466",
        "type": "MODEL_HOLOGRAM",
        "targetID": "df54c477-8eeb-4530-b989-4cb3cdcd6512"
      },
      "sdks": [
        true,
        true,
        false,
        true,
        false,
        false,
        false,
        true,
        true
      ],
      "additionalData": {
        "vuforiaHologramStorageID": "7068cd74-6c9f-4106-9326-585c56fa4475",
        "glbHologramStorageID": "d686a655-e800-430d-bfd2-e38cdfb0c9e9.glb",
        "source": "Skyscraper by Poly by Google, CC-BY, https://poly.google.com/view/dIsZyy2FUY-",
        "qrARjsTargetStorageID": "e7f058d5-5b66-4f50-8cdd-89f057e8070c",
        "qrARjsStorageID": "7cc6adca-ded1-4a46-a289-c07c07cb2f5c",
        "vuforiaHologramStorageFilename": "Skyscraper.h",
        "qrARjsMarkerStorageID": "5de99f4d-9602-45f0-b5ce-7ef53541cb18",
        "glbHologramStorageFilename": "Skyscraper.glb"
      }
    }
  }
}

Entry type '<TYPE>' not associated with key '<API_KEY>'.

Get entries based on location

GET https://api.echo3D.com/query?key=<API_KEY>&location=<LAT>,<LONG>&radius=<RADIUS>

Query Parameters

{
  "apiKey": "<API_KEY>",
  "db": {
    "62714211-a573-40ab-9ae2-d2c9aff68c5a": {
      "id": "62714211-a573-40ab-9ae2-d2c9aff68c5a",
      "target": {
        "place": "New York",
        "latitude": 40.776653,
        "longitude": -73.9547,
        "id": "c1cc0e59-3294-459e-a7ce-a9d14cf2dbdd",
        "type": "GEOLOCATION_TARGET",
        "holograms": [
          "038ecebe-9d81-4a3b-aa8b-f33fbf0e1a1b"
        ]
      },
      "hologram": {
        "filename": "Skyscraper.obj",
        "storageID": "d686a655-e800-430d-bfd2-e38cdfb0c9e9",
        "textureFilenames": [
          "Skyscraper_BaseColor.png"
        ],
        "textureStorageIDs": [
          "f9b43711-cf79-44e5-90c5-ac781c8d9288"
        ],
        "materialFilename": "Skyscraper.mtl",
        "materialStorageID": "891d0b32-4f4b-4f7d-a2e2-d5922611928d",
        "id": "038ecebe-9d81-4a3b-aa8b-f33fbf0e1a1b",
        "type": "MODEL_HOLOGRAM",
        "targetID": "c1cc0e59-3294-459e-a7ce-a9d14cf2dbdd"
      },
      "sdks": [
        true,
        true,
        false,
        true,
        false,
        false,
        false,
        true,
        true
      ],
      "additionalData": {
        "vuforiaHologramStorageID": "7068cd74-6c9f-4106-9326-585c56fa4475",
        "glbHologramStorageID": "d686a655-e800-430d-bfd2-e38cdfb0c9e9.glb",
        "source": "Skyscraper by Poly by Google, CC-BY, https://poly.google.com/view/dIsZyy2FUY-",
        "qrARjsTargetStorageID": "e7f058d5-5b66-4f50-8cdd-89f057e8070c",
        "qrARjsStorageID": "7cc6adca-ded1-4a46-a289-c07c07cb2f5c",
        "vuforiaHologramStorageFilename": "Skyscraper.h",
        "qrARjsMarkerStorageID": "5de99f4d-9602-45f0-b5ce-7ef53541cb18",
        "glbHologramStorageFilename": "Skyscraper.glb"
      }
    }
  }
}

No entires located '<RADUIS>' miles around '<LAT,LONG>' associated with key '<API_KEY>'

PreviousObjects NextData

Last updated 9 months ago