curl
curl -sS -X POST "https://gateway.orbit/api/v1/instances/12/annotations" \
--cacert /path/to/orbit-root-ca.pem \
-H 'Accept: application/json' \
-H 'X-Orbit-Request-Id: 9d6b1e5c-4a3f-4a1b-9f0e-6d2c3f5a7b81' \
-H 'Content-Type: application/json' \
-d '{"id": "example", "comment": "example", "x": 1, "y": 1, "timestamp": 1, "url": "example", "pathname": "example", "element": "example", "elementPath": "example"}'{
"data": {
"id": "<string>",
"threadId": "<string>",
"comment": "<string>",
"x": 50,
"y": 123,
"timestamp": 1,
"url": "<string>",
"pathname": "<string>",
"element": "<string>",
"elementPath": "<string>",
"isFixed": true,
"boundingBox": {
"x": 123,
"y": 123,
"width": 123,
"height": 123
},
"screenshot": "<string>",
"component": "<string>",
"controller": "<string>",
"route": "<string>",
"screenSize": "<string>",
"scrollPosition": "<string>",
"breakpoint": "<string>",
"react": "<string>",
"instanceId": 123,
"taskId": 123,
"taskGroupId": 123,
"revision": 123,
"status": "pending",
"delivery": "queued",
"syncError": "<string>",
"summary": "<string>"
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"data": {
"id": "<string>",
"threadId": "<string>",
"comment": "<string>",
"x": 50,
"y": 123,
"timestamp": 1,
"url": "<string>",
"pathname": "<string>",
"element": "<string>",
"elementPath": "<string>",
"isFixed": true,
"boundingBox": {
"x": 123,
"y": 123,
"width": 123,
"height": 123
},
"screenshot": "<string>",
"component": "<string>",
"controller": "<string>",
"route": "<string>",
"screenSize": "<string>",
"scrollPosition": "<string>",
"breakpoint": "<string>",
"react": "<string>",
"instanceId": 123,
"taskId": 123,
"taskGroupId": 123,
"revision": 123,
"status": "pending",
"delivery": "queued",
"syncError": "<string>",
"summary": "<string>"
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Annotations
annotation:create
POST
/
api
/
v1
/
instances
/
{instance}
/
annotations
curl
curl -sS -X POST "https://gateway.orbit/api/v1/instances/12/annotations" \
--cacert /path/to/orbit-root-ca.pem \
-H 'Accept: application/json' \
-H 'X-Orbit-Request-Id: 9d6b1e5c-4a3f-4a1b-9f0e-6d2c3f5a7b81' \
-H 'Content-Type: application/json' \
-d '{"id": "example", "comment": "example", "x": 1, "y": 1, "timestamp": 1, "url": "example", "pathname": "example", "element": "example", "elementPath": "example"}'{
"data": {
"id": "<string>",
"threadId": "<string>",
"comment": "<string>",
"x": 50,
"y": 123,
"timestamp": 1,
"url": "<string>",
"pathname": "<string>",
"element": "<string>",
"elementPath": "<string>",
"isFixed": true,
"boundingBox": {
"x": 123,
"y": 123,
"width": 123,
"height": 123
},
"screenshot": "<string>",
"component": "<string>",
"controller": "<string>",
"route": "<string>",
"screenSize": "<string>",
"scrollPosition": "<string>",
"breakpoint": "<string>",
"react": "<string>",
"instanceId": 123,
"taskId": 123,
"taskGroupId": 123,
"revision": 123,
"status": "pending",
"delivery": "queued",
"syncError": "<string>",
"summary": "<string>"
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"data": {
"id": "<string>",
"threadId": "<string>",
"comment": "<string>",
"x": 50,
"y": 123,
"timestamp": 1,
"url": "<string>",
"pathname": "<string>",
"element": "<string>",
"elementPath": "<string>",
"isFixed": true,
"boundingBox": {
"x": 123,
"y": 123,
"width": 123,
"height": 123
},
"screenshot": "<string>",
"component": "<string>",
"controller": "<string>",
"route": "<string>",
"screenSize": "<string>",
"scrollPosition": "<string>",
"breakpoint": "<string>",
"react": "<string>",
"instanceId": 123,
"taskId": 123,
"taskGroupId": 123,
"revision": 123,
"status": "pending",
"delivery": "queued",
"syncError": "<string>",
"summary": "<string>"
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Path Parameters
Numeric Instance ID.
Required range:
x >= 1Body
application/json
Maximum string length:
128Pattern:
^[a-zA-Z0-9_-]+$Maximum string length:
20000Required range:
0 <= x <= 100Required range:
x >= 0Maximum string length:
4096Maximum string length:
4096Maximum string length:
1000Maximum string length:
10000Maximum string length:
128Pattern:
^[a-zA-Z0-9_-]+$Show child attributes
Show child attributes
Maximum string length:
3000000Pattern:
^data:image\/(png|jpeg|webp);base64,Maximum string length:
4096Maximum string length:
4096Maximum string length:
4096Maximum string length:
100Maximum string length:
100Maximum string length:
100Maximum string length:
10000