Insights

Areas of interest or concern that are identified during the analysis of land.

Export insights in CSV format

get

Authorizations

bearer

AuthorizationstringRequired

M2M authentication token

Query parameters

criticalitystringOptional

Filter insights by criticality. Multiple values separated by comma. Valid values: low, medium, high

Example: high,medium

createdTodateOptional

Filter insights created until this date (inclusive). ISO 8601 format.

Example: 2024-05-10T23:59:59.999Z

createdFromdateOptional

Filter insights created from this date (inclusive). ISO 8601 format.

Example: 2024-02-10T00:00:00.000Z

statusstringOptional

Filter insights by review status. Multiple values separated by comma. Valid values: new, pending, assigned, closed

Example: new,assigned

Responses

200

CSV containing insights data

text/csv

string · binaryOptional

400

Bad Request - Invalid query parameters

application/json

401

Unauthorized - Missing or invalid M2M token

application/json

403

Forbidden - Invalid M2M audience

application/json

get

/v1/insights/csv

HTTPcURLJavaScriptPython

GET /v1/insights/csv HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

insightId,timestepBefore,timestepAfter,mapLink,distanceToAsset,criticality,status,caseId,caseTitle,delivery,changeType,detectedBy,geometry,createdAt,imageBefore,imageAfter,imageBeforeId,imageAfterId
550e8400-e29b-41d4-a716-446655440002,2024-01-15,2024-02-15,https://www.google.com/maps/search/?api=1&query=23.16676929357106,57.85571911720045,25.3,high,New,550e8400-e29b-41d4-a716-446655440003,Case Title Example,delivery-123,Leakage,Patrol,"{""type"":""Polygon"",""coordinates"":[[[0,0],[1,0],[1,1],[0,1],[0,0]]]}",2024-01-15,https://example.com/image1,https://example.com/image2,550e8400-e29b-41d4-a716-446655440000,550e8400-e29b-41d4-a716-446655440001

Export insights in GeoJSON format

get

Authorizations

bearer

AuthorizationstringRequired

M2M authentication token

Query parameters

criticalitystringOptional

Filter insights by criticality. Multiple values separated by comma. Valid values: low, medium, high

Example: high,medium

createdTodateOptional

Filter insights created until this date (inclusive). ISO 8601 format.

Example: 2024-05-10T23:59:59.999Z

createdFromdateOptional

Filter insights created from this date (inclusive). ISO 8601 format.

Example: 2024-02-10T00:00:00.000Z

statusstringOptional

Filter insights by review status. Multiple values separated by comma. Valid values: new, pending, assigned, closed

Example: new,assigned

Responses

200

GeoJSON containing insights data

application/geo+json

typestringRequiredExample: FeatureCollection

400

Bad Request - Invalid query parameters

application/json

401

Unauthorized - Missing or invalid M2M token

application/json

403

Forbidden - Invalid M2M audience

application/json

get

/v1/insights/geojson

HTTPcURLJavaScriptPython

GET /v1/insights/geojson HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "insightId": "550e8400-e29b-41d4-a716-446655440002",
        "timestepBefore": "2024-01-15",
        "timestepAfter": "2024-02-15",
        "mapLink": "https://www.google.com/maps/search/?api=1&query=23.16676929357106,57.85571911720045",
        "distanceToAsset": 25.3,
        "criticality": "high",
        "status": "new",
        "caseId": "550e8400-e29b-41d4-a716-446655440003",
        "caseTitle": "Case Title Example",
        "delivery": "delivery-123",
        "changeType": "Leakage",
        "detectedBy": "Patrol",
        "createdAt": "2024-01-15",
        "imageBefore": "https://example.com/image1",
        "imageAfter": "https://example.com/image2",
        "imageBeforeId": "550e8400-e29b-41d4-a716-446655440000",
        "imageAfterId": "550e8400-e29b-41d4-a716-446655440001",
        "mediaIds": "550e8400-e29b-41d4-a716-446655440004;550e8400-e29b-41d4-a716-446655440005"
      },
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              -122.4194,
              37.7749
            ],
            [
              -122.4194,
              37.7759
            ],
            [
              -122.4184,
              37.7759
            ],
            [
              -122.4184,
              37.7749
            ],
            [
              -122.4194,
              37.7749
            ]
          ]
        ]
      }
    }
  ]
}