surveys

Retrieve a list of surveys.

Arguments

date_range (DateRange)

Filter the results by date range.

order_by (SurveySortingAttributes)

Order the results by a specific attribute.

order_by_direction (SortDirection)

Direction (ascending or descending) of the ordered results.

organization_sentera_id (ID)

List surveys for this organization.

pagination (Pagination)

Paginate the results.

Return fields

page (Int!)

The page of results returned in this structure when using pagination.

page_size (Int!)

The number of results returned in this structure when using pagination.

present (Boolean!)

Whether or not there are any results in this structure.

results ([Survey]!)

A collection of surveys matching the query constraints.

total_count (Int!)

The total number of items matching the query constraints.

Examples

Surveys constrained by date range

Retrieve surveys based on a date range.

Try this example in GraphiQL

query SurveysByDateRange {
  surveys (
  date_range: {
    date_attribute_name: "start_time"
    start_timestamp: "2017-09-03T04:53:28Z"
    end_timestamp: "2017-09-08T04:48:28Z"
  }
  ) {
  total_count
  results {
    sentera_id
    start_time
    end_time
  }
  }
}

{
  "data": {
  "surveys": {
    "total_count": 54,
    "results": [
      {
        "sentera_id": "itqkn28_CO_SHORT1_CV_test_dc0d87d_170907_235328",
        "start_time": "2017-09-03T16:25:32Z",
        "end_time": "2017-09-03T16:45:32Z"
      }
    ]
  }
  }
}

Survey mosaics constrained by quality

Retrieve survey mosaics based on a specific quality.

Try this example in GraphiQL

query SurveyMosaicsByQuality {
  surveys {
  results {
    mosaics (quality: FULL) {
      results {
        files {
          filename
          url
        }
      }
    }
  }
  }
}

{
  "data": {
  "surveys": {
    "results": [
      {
        "mosaics": {
          "results": [
            {
              "files": [
                {
                  "filename": "odm_orthophoto_ndvi.tif",
                  "url": "Pre-signed Amazon S3 URL"
                },
                {
                  "filename": "odm_orthophoto_ndvi.prj",
                  "url": "Pre-signed Amazon S3 URL"
                },
                {
                  "filename": "odm_orthophoto_ndvi.tfw",
                  "url": "Pre-signed Amazon S3 URL"
                }
              ]
            }
          ]
        }
      }
    ]
  }
  }
}

Ordering surveys

Retrieve surveys ordered by a specific attribute. Refer here for a complete list of attributes that can be used to order surveys.

Try this example in GraphiQL

query SurveysWithOrdering {
  surveys (
  order_by: START_TIME
  order_by_direction: DESCENDING
  ) {
  total_count
  results {
    sentera_id
    start_time
    end_time
  }
  }
}

{
  "data": {
  "surveys": {
    "total_count": 54,
    "results": [
      {
        "sentera_id": "itqkn28_CO_SHORT1_CV_test_dc0d87d_170907_235328",
        "start_time": "2017-09-03T16:25:32Z",
        "end_time": "2017-09-03T16:45:32Z"
      }
    ]
  }
  }
}

Paginating surveys

Retrieve surveys a page at a time.

Try this example in GraphiQL

query SurveysWithPagination {
  surveys(
  pagination: {
    page: 2
    page_size: 30
  }
  ) {
  total_count
  page
  page_size
  results {
    sentera_id
    start_time
    end_time
  }
  }
}

{
  "data": {
  "surveys": {
    "total_count": 54,
    "page": 2,
    "page_size": 30,
    "results": [
      {
        "sentera_id": "itqkn28_CO_SHORT1_CV_test_dc0d87d_170907_235328",
        "start_time": "2017-09-03T16:25:32Z",
        "end_time": "2017-09-03T16:45:32Z"
      }
    ]
  }
  }
}

Surveys within a specific organization

Retrieve surveys based an organization ID.

This organization can be one of:

The calling user's assigned organization
A child of that assigned organization
An organization with which the calling user is partnered
A child of an organization with which the calling user is partnered

Try this example in GraphiQL

query SurveysForOrganization {
  surveys (
  organization_sentera_id: "fkqbg8f_OR_8y24DenisOrgC_CV_stag_1de18e2_200806_133132"
  ) {
  total_count
  results {
    sentera_id
    start_time
    end_time
  }
  }
}

{
  "data": {
  "surveys": {
    "total_count": 54,
    "results": [
      {
        "sentera_id": "itqkn28_CO_SHORT1_CV_test_dc0d87d_170907_235328",
        "start_time": "2017-09-03T16:25:32Z",
        "end_time": "2017-09-03T16:45:32Z"
      }
    ]
  }
  }
}