API Reference

Reference of the data entities and the related API endpoints.

Note

The API endpoint payloads and responses shown in this documents pretend to be exact examples of valid API requests. The values shown there can be used as a reference of how they should look like in real operations.

Contents

• Field
  • GET /v1/fields
  • GET /v1/fields/<field_id>
  • POST /v1/fields
  • POST /v1/fields/detection
  • POST /v1/fields/detection/_preview
  • POST /v1/fields/detection/bulk
  • POST /v1/fields/detection/bulk/_preview
  • Deprecation Schedule
• Reported Data
  • POST /v1/reported-data
• Request
  • POST /v1/requests
  • GET /v1/requests
  • GET /v1/requests/<request_id>/results