👁‍🗨 Queries

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

get
Get entries

https://console.echoAR.xyz/query?key=<API_KEY>
This query allows you to retrieve a data set of entries associated with your API key.
Request
Response
Request
Query Parameters
key
required
string
Your API key.
Response
200: OK
Set of entries successfully retrieved.
{
"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"
}
}
}
}
404: Not Found
Could not find the API key.
Key '<API_KEY>' not found!

get
Get a specific entry

https://console.echoAR.xyz/query?key=<API_KEY>&entry=<ENTRY_ID>
This query allows you to retrieve a specific entry.
Request
Response
Request
Query Parameters
key
required
string
Your API key.
entry
required
string
A specific entry ID.
Response
200: OK
{
"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"
}
}
}
}
400: Bad Request
Entry ID '<ENTRY_ID>' not associated with key '<API_KEY>'.

get
Get entries based on file

https://console.echoAR.xyz/query?key=<API_KEY>&filename=<FILENAME>
This query allows you to retrieve entries that contain a specific file.
Request
Response
Request
Query Parameters
key
required
string
Your API key.
filename
required
string
A file name, e.g. myfile.obj.
Response
200: OK
Set of entries successfully retrieved.
{
"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"
}
}
}
}
400: Bad Request
No entries found containing a file named '<FILENAME>' associated with key '<API_KEY>'.

get
Get entries based on data

https://console.echoAR.xyz/query?key=<API_KEY>&data=<DATA>&value=<VALUE>
This query allows you to retrieve entries that contain a specific data key and value.
Request
Response
Request
Query Parameters
key
required
string
Your API key.
data
required
string
A data key, e.g. scale.
value
optional
string
A data value, e.g. 2.
Response
200: OK
{
"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"
}
}
}
}
400: Bad Request
Entries with <data, value> pair '<DATA>,<VALUE>' not associated with key '<API_KEY>'.

get
Get entries based on type

https://console.echoAR.xyz/query?key=<API_KEY>&type=<TYPE>
This query allows you to retrieve entries that contain a specific type of hologram or target.
Request
Response
Request
Query Parameters
key
required
string
Your API key.
type
required
string
A type of hologram or target. Options: MODEL_HOLOGRAM, VIDEO_HOLOGRAM, BRICK_TARGET, LOCATION_TARGET, or IMAGE_TARGET
Response
200: OK
{
"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"
}
}
}
}
400: Bad Request
Entry type '<TYPE>' not associated with key '<API_KEY'.