id required | string UUID organization identifier |
name required | string Name of the organization. Typically this is your company name. |
[- {
- "id": "48d90287-49ed-4ab3-aa7c-694336228058",
- "name": "H&M Construction"
}
]
organizationId required | string <uuid> |
id required | string UUID organization identifier |
name required | string Name of the organization. Typically this is your company name. |
{- "id": "48d90287-49ed-4ab3-aa7c-694336228058",
- "name": "H&M Construction"
}
organizationId required | string <uuid> |
id required | string UUID project identifier |
name required | string Name of the project |
location required | object (GeoJSON.Point) GeoJSON point representing where in the world the project is located |
created required | string <date-time> Date and time the project was created |
organizationId required | string Organization ID for the organization that owns this project |
required | object What permissions the requesting user has on this project (read-only) |
outputCoordinateSystem required | string The 3D projected coordinate system used for output data products and visualization in this project |
[- {
- "id": "a364612c-3873-4be2-b029-cfc8d459b2c3",
- "name": "Oceanside Hotel",
- "location": {
- "type": "Point",
- "coordinates": [
- -95.8587,
- 40.6765
]
}, - "outputCoordinateSystem": "EPSG:2227+ARBITRARY:foot_survey_us",
- "created": "2018-09-07T22:20:22.995Z",
- "organizationId": "5a82a0ac-168f-4af4-95ed-224aae224f83",
- "myPermissions": {
- "read": true,
- "write": true,
- "comment": true,
- "fly": true
}
}
]
organizationId required | string <uuid> |
id required | string User ID of this user |
name | string Full name of this user |
email required | string User's email address |
[- {
- "id": "02ce865b-3822-45c1-92e6-cdf0e5cb7de1",
- "name": "Roger Easton",
- "email": "roger@example.com"
}, - {
- "id": "eef487ac-bd97-4211-85bf-d7d470e6d40d",
- "name": "Gladys West",
- "email": "gladys@example.com"
}, - {
- "id": "9be937e6-f09f-44a2-ae46-294216bd41ac",
- "name": "Ivan Getting",
- "email": "ivan@example.com"
}
]
organizationId required | string <uuid> |
start | string <date> Start date (format: YYYY-MM-DD) Filter to include activity only after 00:00 UTC on this day |
end | string <date> End date (format: YYYY-MM-DD) Filter to include activity only before 23:59:59 UTC on this day |
by | string Enum: "project" "user" Group the output by project or by user. This data is only available for date ranges beginning July 2021. |
photos | integer Count of photos uploaded |
bytes | integer Total bytes of photos uploaded |
pixels | integer Total pixels of photos uploaded |
ndays | integer Number of days (UTC) on which any photos were uploaded |
userId | string With ID |
projectId | string With ID |
{- "photos": 135,
- "bytes": 9858856,
- "pixels": 419904000,
- "ndays": 2
}
organizationId required | string <uuid> |
id required | string UUID project identifier |
name required | string Name of the project |
location required | object (GeoJSON.Point) GeoJSON point representing where in the world the project is located |
created required | string <date-time> Date and time the project was created |
organizationId required | string Organization ID for the organization that owns this project |
required | object What permissions the requesting user has on this project (read-only) |
outputCoordinateSystem required | string The 3D projected coordinate system used for output data products and visualization in this project |
[- {
- "id": "a364612c-3873-4be2-b029-cfc8d459b2c3",
- "name": "Oceanside Hotel",
- "location": {
- "type": "Point",
- "coordinates": [
- -95.8587,
- 40.6765
]
}, - "outputCoordinateSystem": "EPSG:2227+ARBITRARY:foot_survey_us",
- "created": "2018-09-07T22:20:22.995Z",
- "organizationId": "5a82a0ac-168f-4af4-95ed-224aae224f83",
- "myPermissions": {
- "read": true,
- "write": true,
- "comment": true,
- "fly": true
}
}
]
Create project
organizationId required | string <uuid> |
id | string UUID project identifier |
name required | string [ 1 .. 200 ] characters Name of the project |
location | object (GeoJSON.Point) GeoJSON point representing where in the world the project is located |
created | string <date-time> Date and time the project was created |
outputCoordinateSystem required | string The 3D projected coordinate system used for output data products and visualization in this project |
id required | string UUID project identifier |
name required | string Name of the project |
location required | object (GeoJSON.Point) GeoJSON point representing where in the world the project is located |
created required | string <date-time> Date and time the project was created |
organizationId required | string Organization ID for the organization that owns this project |
required | object What permissions the requesting user has on this project (read-only) |
outputCoordinateSystem required | string The 3D projected coordinate system used for output data products and visualization in this project |
{- "name": "Oceanside Hotel",
- "location": {
- "type": "Point",
- "coordinates": [
- -95.8587,
- 40.6765
]
}, - "outputCoordinateSystem": "EPSG:2227+ARBITRARY:foot_survey_us"
}
{- "id": "a364612c-3873-4be2-b029-cfc8d459b2c3",
- "name": "Oceanside Hotel",
- "location": {
- "type": "Point",
- "coordinates": [
- -95.8587,
- 40.6765
]
}, - "outputCoordinateSystem": "EPSG:2227+ARBITRARY:foot_survey_us",
- "created": "2018-09-07T22:20:22.995Z",
- "organizationId": "5a82a0ac-168f-4af4-95ed-224aae224f83",
- "myPermissions": {
- "read": true,
- "write": true,
- "comment": true,
- "fly": true
}
}
projectId required | string <uuid> |
id required | string UUID project identifier |
name required | string Name of the project |
location required | object (GeoJSON.Point) GeoJSON point representing where in the world the project is located |
created required | string <date-time> Date and time the project was created |
organizationId required | string Organization ID for the organization that owns this project |
required | object What permissions the requesting user has on this project (read-only) |
outputCoordinateSystem required | string The 3D projected coordinate system used for output data products and visualization in this project |
{- "id": "a364612c-3873-4be2-b029-cfc8d459b2c3",
- "name": "Oceanside Hotel",
- "location": {
- "type": "Point",
- "coordinates": [
- -95.8587,
- 40.6765
]
}, - "outputCoordinateSystem": "EPSG:2227+ARBITRARY:foot_survey_us",
- "created": "2018-09-07T22:20:22.995Z",
- "organizationId": "5a82a0ac-168f-4af4-95ed-224aae224f83",
- "myPermissions": {
- "read": true,
- "write": true,
- "comment": true,
- "fly": true
}
}
Get a list of the missions associated with a project.
These result objects do not include associated output data. Request an individual mission by ID to get download links for data.
projectId required | string <uuid> |
id required | string Mission ID |
name required | string Name of the mission |
flownBy | string User ID of the person who flew the flight |
created required | string <date-time> Date and time the mission was created in the database |
projectId required | string Project ID of the project that contains this mission |
flightPlan | string Flight plan ID of the flight plan used as a template when planning the mission. The mission may have been modified before flight and no longer match the flight plan. |
object Information about the drone that was used for this flight | |
flightMode | any Enum: "survey" "crosshatch" "perimeterScan" "inspect" "panorama" "verticalScan" "corridor" Flight mode selected in Site Scan Field when planning the mission. |
startTime | string <date-time> Time when the physical flight began |
endTime | string <date-time> Time when the physical flight ended |
state | any Enum: "metadataUploaded" "photosUploading" "photosUploaded" Current state of the mission |
takeoffLocation | object (GeoJSON.Point) Location where the drone took off |
gcpSetId | string GCP Set ID used to process the mission |
[- {
- "id": "3087a33b-5cf0-4bb0-8760-ff055de3a96f",
- "projectId": "6ca12bcd-ac49-495e-a1a0-5387cfe51bb4",
- "name": "Crosshatch Sep 7 West",
- "created": "2018-09-07T22:18:39.884Z",
- "startTime": "2018-09-07T22:20:41.332Z",
- "endTime": "2018-09-07T22:29:47.915Z",
- "state": "photosUploaded",
- "vehicle": {
- "model": "phantom4pro",
- "serial": "07324323234234",
- "battery": [
- {
- "serial": "0324543253"
}
]
}
}
]
It is highly recommended to create missions only via the Site Scan Field app on iOS, as it uploads many additional metadata fields to optimize processing and provide fleet management data.
projectId required | string <uuid> |
id | string Mission ID |
name required | string <= 200 characters Name of the mission |
flownBy | string <uuid> User ID of the person who flew the flight |
created | string <date-time> Date and time the mission was created in the database |
flightPlan | string <uuid> Flight plan ID of the flight plan used as a template when planning the mission. The mission may have been modified before flight and no longer match the flight plan. |
object Information about the drone that was used for this flight | |
flightMode | any Enum: "survey" "crosshatch" "perimeterScan" "inspect" "panorama" "verticalScan" "corridor" Flight mode selected in Site Scan Field when planning the mission. |
startTime | string <date-time> Time when the physical flight began |
endTime | string <date-time> Time when the physical flight ended |
state | any Enum: "metadataUploaded" "photosUploading" "photosUploaded" Current state of the mission |
takeoffLocation | object (GeoJSON.Point) Location where the drone took off |
gcpSetId | string <uuid> GCP Set ID used to process the mission |
id required | string Mission ID |
name required | string Name of the mission |
flownBy | string User ID of the person who flew the flight |
created required | string <date-time> Date and time the mission was created in the database |
projectId required | string Project ID of the project that contains this mission |
flightPlan | string Flight plan ID of the flight plan used as a template when planning the mission. The mission may have been modified before flight and no longer match the flight plan. |
object Information about the drone that was used for this flight | |
flightMode | any Enum: "survey" "crosshatch" "perimeterScan" "inspect" "panorama" "verticalScan" "corridor" Flight mode selected in Site Scan Field when planning the mission. |
startTime | string <date-time> Time when the physical flight began |
endTime | string <date-time> Time when the physical flight ended |
state | any Enum: "metadataUploaded" "photosUploading" "photosUploaded" Current state of the mission |
takeoffLocation | object (GeoJSON.Point) Location where the drone took off |
gcpSetId | string GCP Set ID used to process the mission |
{- "name": "Crosshatch Sep 7 West"
}
{- "id": "3087a33b-5cf0-4bb0-8760-ff055de3a96f",
- "projectId": "6ca12bcd-ac49-495e-a1a0-5387cfe51bb4",
- "name": "Crosshatch Sep 7 West",
- "created": "2018-09-07T22:18:39.884Z",
- "startTime": "2018-09-07T22:20:41.332Z",
- "endTime": "2018-09-07T22:29:47.915Z",
- "state": "photosUploaded",
- "vehicle": {
- "model": "phantom4pro",
- "serial": "07324323234234",
- "battery": [
- {
- "serial": "0324543253"
}
]
}
}
Get all the sets of Ground Control Points (GCPs) associated with a project
projectId required | string <uuid> |
id | string Arbitrary UUID string identifying the GCP Set |
projectId required | string Project ID of the project containing this GCP set |
gcps | Array of any The GCPs of this set |
created | string <date-time> Date this GCP set was created |
crs | string String describing the coordinate system the GCPs are specified in |
[- {
- "id": "83378040-9d9e-473d-97d5-047fce1897fe",
- "docType": "gcpSet",
- "projectId": "c23a3931-aaea-4d08-839a-15935a60d0c9",
- "crs": "EPSG:4326+ARBITRARY:m",
- "gcps": [
- {
- "label": "Point 1",
- "description": "",
- "inputLocation": [
- 38.6527618185,
- -121.073774027,
- 169.4347135
], - "location": {
- "type": "Point",
- "coordinates": [
- -121.073774027,
- 38.6527618185
]
}
}, - {
- "label": "Point 2",
- "description": "",
- "inputLocation": [
- 38.6528672477,
- -121.073461579,
- 169.274502174
], - "location": {
- "type": "Point",
- "coordinates": [
- -121.073461579,
- 38.6528672477
]
}
}, - {
- "label": "Point 3",
- "description": "",
- "inputLocation": [
- 38.6534225632,
- -121.073289825,
- 169.3866125
], - "location": {
- "type": "Point",
- "coordinates": [
- -121.073289825,
- 38.6534225632
]
}
}, - {
- "label": "Point 4",
- "description": "",
- "inputLocation": [
- 38.653585566,
- -121.073159209,
- 169.530219
], - "location": {
- "type": "Point",
- "coordinates": [
- -121.073159209,
- 38.653585566
]
}
}, - {
- "label": "Point 5",
- "description": "",
- "inputLocation": [
- 38.6534916743,
- -121.073520019,
- 169.8914985
], - "location": {
- "type": "Point",
- "coordinates": [
- -121.073520019,
- 38.6534916743
]
}
}, - {
- "label": "Point 6",
- "description": "",
- "inputLocation": [
- 38.6533034054,
- -121.073879207,
- 170.112912
], - "location": {
- "type": "Point",
- "coordinates": [
- -121.073879207,
- 38.6533034054
]
}
}, - {
- "label": "Point 7",
- "description": "",
- "inputLocation": [
- 38.6532377945,
- -121.074093059,
- 171.347981
], - "location": {
- "type": "Point",
- "coordinates": [
- -121.074093059,
- 38.6532377945
]
}
}, - {
- "label": "Point 8",
- "description": "",
- "inputLocation": [
- 38.653054717,
- -121.074851944,
- 171.118227
], - "location": {
- "type": "Point",
- "coordinates": [
- -121.074851944,
- 38.653054717
]
}
}, - {
- "label": "Point 9",
- "description": "",
- "inputLocation": [
- 38.6526642492,
- -121.074358811,
- 168.4752765
], - "location": {
- "type": "Point",
- "coordinates": [
- -121.074358811,
- 38.6526642492
]
}
}
], - "acl": [
- {
- "id": "734a3451-e0a1-4017-937f-7d8c662c3c96",
- "kind": "user",
- "permission": "Admin$"
}
], - "created": "2017-10-09T22:04:23.094Z"
}
]
A mission is the record of data collection at particular location and time, and contain the photos captured by the drone, and the processed output data products. Missions uploaded by the iOS app include metadata about the drone and flight.
Get a list of the missions associated with a project.
These result objects do not include associated output data. Request an individual mission by ID to get download links for data.
projectId required | string <uuid> |
id required | string Mission ID |
name required | string Name of the mission |
flownBy | string User ID of the person who flew the flight |
created required | string <date-time> Date and time the mission was created in the database |
projectId required | string Project ID of the project that contains this mission |
flightPlan | string Flight plan ID of the flight plan used as a template when planning the mission. The mission may have been modified before flight and no longer match the flight plan. |
object Information about the drone that was used for this flight | |
flightMode | any Enum: "survey" "crosshatch" "perimeterScan" "inspect" "panorama" "verticalScan" "corridor" Flight mode selected in Site Scan Field when planning the mission. |
startTime | string <date-time> Time when the physical flight began |
endTime | string <date-time> Time when the physical flight ended |
state | any Enum: "metadataUploaded" "photosUploading" "photosUploaded" Current state of the mission |
takeoffLocation | object (GeoJSON.Point) Location where the drone took off |
gcpSetId | string GCP Set ID used to process the mission |
[- {
- "id": "3087a33b-5cf0-4bb0-8760-ff055de3a96f",
- "projectId": "6ca12bcd-ac49-495e-a1a0-5387cfe51bb4",
- "name": "Crosshatch Sep 7 West",
- "created": "2018-09-07T22:18:39.884Z",
- "startTime": "2018-09-07T22:20:41.332Z",
- "endTime": "2018-09-07T22:29:47.915Z",
- "state": "photosUploaded",
- "vehicle": {
- "model": "phantom4pro",
- "serial": "07324323234234",
- "battery": [
- {
- "serial": "0324543253"
}
]
}
}
]
Get mission details by ID. This request returns a single mission and the latest version of its dataproducts.
missionId required | string <uuid> |
id required | string ID of this mission |
name required | string Name of the mission |
flownBy | string User ID of the person who flew the flight |
created required | string <date-time> Date and time the flight was created in the database |
projectId required | string Project ID of the project that contains this flight |
flightPlan | string Flight plan ID of the flight plan used as a template when planning the mission. The mission may have been modified before flight and no longer match the flight plan. |
object Information about the drone that was used for this flight | |
flightMode | any Enum: "survey" "crosshatch" "perimeterScan" "inspect" "panorama" "verticalScan" "corridor" Flight mode selected in Site Scan Field when planning the mission. |
startTime | string <date-time> Time when the physical flight began |
endTime | string <date-time> Time when the physical flight ended |
state | any Enum: "metadataUploaded" "photosUploading" "photosUploaded" Current state of the mission |
takeoffLocation | object (GeoJSON.Point) Location where the drone took off |
gcpSetId | string GCP Set ID used to process the mission |
object Collection of data products produced by this mission |
{- "id": "3087a33b-5cf0-4bb0-8760-ff055de3a96f",
- "projectId": "6ca12bcd-ac49-495e-a1a0-5387cfe51bb4",
- "name": "Crosshatch Sep 7 West",
- "created": "2018-09-07T22:18:39.884Z",
- "startTime": "2018-09-07T22:20:41.332Z",
- "endTime": "2018-09-07T22:29:47.915Z",
- "state": "photosUploaded",
- "vehicle": {
- "model": "phantom4pro",
- "serial": "07324323234234",
- "battery": [
- {
- "serial": "0324543253"
}
]
}
}
Initiate photogrammetry processing for mission.
missionId required | string <uuid> |
meshEngine | any Enum: "off" "sure" |
sureQuality | any Enum: "Low" "Medium" "High" "Ultra" |
{- "meshEngine": "off"
}
missionId required | string |
id required | string Media ID of this photo |
name required | string Original filename of the photo |
missionId required | string ID of the mission containing this photo |
url required | string Download URL for the full-resolution photo |
location | object (GeoJSON.Point) GeoJSON encoding of the location of the drone when it took this photo |
contentType required | string MIME type of the photo. This will only contain |
created required | string <date-time> Date and time the photo was created |
related | Array of any A list of other media related to this photo. Generally this will be thumbnails of the current photo with resolution data. |
sha256 | string SHA-256 hash of the image file. This may not be populated for images uploaded prior to October 2018. |
imageDimensions | any Pixel width and height of the image (in that order) |
[- {
- "id": "d7d16e4b-0f20-45e2-8fd0-3556e2b2ff6c",
- "name": "DJI_2022.JPG",
- "missionId": "4481ce54-e98b-412c-9719-21373835c9c5",
- "location": {
- "type": "Point",
- "coordinates": [
- -121.07403888888888,
- 38.65331944444444
]
}, - "contentType": "image/*",
- "created": "2017-10-12T21:57:15.980Z",
- "related": [
- {
- "attributes": {
- "height": 149,
- "width": 224,
- "size": "small",
- "resolution": "mdpi"
}
}, - {
- "attributes": {
- "height": 332,
- "width": 500,
- "size": "medium",
- "resolution": "mdpi"
}
}
], - "gcpTags": [
- {
- "gcpSetId": "83378040-9d9e-473d-97d5-047fce1897fe",
- "indexWithinGCPSet": 6,
- "x": 2064.028564453125,
- "y": 2769.403564453125
}
]
}
]
Add a new photo to a mission
missionId required | string |
mediaName required | string The filename of the photo you are uploading |
The body of the request should be a multipart form data upload of the image file you wish to upload
id required | string Media ID of this photo |
name required | string Original filename of the photo |
missionId required | string ID of the mission containing this photo |
url required | string Download URL for the full-resolution photo |
location | object (GeoJSON.Point) GeoJSON encoding of the location of the drone when it took this photo |
contentType required | string MIME type of the photo. This will only contain |
created required | string <date-time> Date and time the photo was created |
related | Array of any A list of other media related to this photo. Generally this will be thumbnails of the current photo with resolution data. |
sha256 | string SHA-256 hash of the image file. This may not be populated for images uploaded prior to October 2018. |
imageDimensions | any Pixel width and height of the image (in that order) |
{- "id": "d7d16e4b-0f20-45e2-8fd0-3556e2b2ff6c",
- "name": "DJI_2022.JPG",
- "missionId": "4481ce54-e98b-412c-9719-21373835c9c5",
- "location": {
- "type": "Point",
- "coordinates": [
- -121.07403888888888,
- 38.65331944444444
]
}, - "contentType": "image/*",
- "created": "2017-10-12T21:57:15.980Z",
- "related": [
- {
- "attributes": {
- "height": 149,
- "width": 224,
- "size": "small",
- "resolution": "mdpi"
}
}, - {
- "attributes": {
- "height": 332,
- "width": 500,
- "size": "medium",
- "resolution": "mdpi"
}
}
], - "gcpTags": [
- {
- "gcpSetId": "83378040-9d9e-473d-97d5-047fce1897fe",
- "indexWithinGCPSet": 6,
- "x": 2064.028564453125,
- "y": 2769.403564453125
}
]
}
Gets information about a photo, including the download URL
mediaId required | string |
id required | string Media ID of this photo |
name required | string Original filename of the photo |
missionId required | string ID of the mission containing this photo |
url required | string Download URL for the full-resolution photo |
location | object (GeoJSON.Point) GeoJSON encoding of the location of the drone when it took this photo |
contentType required | string MIME type of the photo. This will only contain |
created required | string <date-time> Date and time the photo was created |
related | Array of any A list of other media related to this photo. Generally this will be thumbnails of the current photo with resolution data. |
sha256 | string SHA-256 hash of the image file. This may not be populated for images uploaded prior to October 2018. |
imageDimensions | any Pixel width and height of the image (in that order) |
{- "id": "d7d16e4b-0f20-45e2-8fd0-3556e2b2ff6c",
- "name": "DJI_2022.JPG",
- "missionId": "4481ce54-e98b-412c-9719-21373835c9c5",
- "location": {
- "type": "Point",
- "coordinates": [
- -121.07403888888888,
- 38.65331944444444
]
}, - "contentType": "image/*",
- "created": "2017-10-12T21:57:15.980Z",
- "related": [
- {
- "attributes": {
- "height": 149,
- "width": 224,
- "size": "small",
- "resolution": "mdpi"
}
}, - {
- "attributes": {
- "height": 332,
- "width": 500,
- "size": "medium",
- "resolution": "mdpi"
}
}
], - "gcpTags": [
- {
- "gcpSetId": "83378040-9d9e-473d-97d5-047fce1897fe",
- "indexWithinGCPSet": 6,
- "x": 2064.028564453125,
- "y": 2769.403564453125
}
]
}