Skip to main content
POST
/
v1
/
companies
/
{company-id}
/
jobs
/
{job-id}
/
geofence_triggers
Calculate GeofenceTriggers for a Job
curl --request POST \
  --url https://api.tread-horizon.com/v1/companies/{company-id}/jobs/{job-id}/geofence_triggers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "strategy": "historical",
  "delay_seconds": 123,
  "geofences": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "moving_geofence": false
    }
  ]
}
'
{
  "data": [
    {
      "triggered_location": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "lat": "<string>",
        "lon": "<string>",
        "occurred_at": "2023-11-07T05:31:56Z",
        "driver": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "first_name": "<string>",
          "last_name": "<string>"
        },
        "equipment": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "external_id": "<string>"
        },
        "order": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "order_id": "<string>"
        },
        "job": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "job_id": "<string>"
        }
      },
      "geofence": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "geofence": {
          "name": "<string>",
          "type": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "geojson": {
            "type": "<string>",
            "coordinates": [
              [
                [
                  "<unknown>"
                ]
              ]
            ]
          },
          "circle_center": {
            "lat": 123,
            "lon": 123
          },
          "circle_radius": 123
        },
        "moving_geofence": false
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Accept-Language
string
default:en

The Accept-Language request HTTP header indicates the natural language and locale that the client prefers.

Example:

"en"

Path Parameters

​
company-id
string<uuid>
required

Company ID

​
job-id
string<uuid>
required

Job ID

Body

application/json

When present, geofences override the job's default geofences (from its sites) for :naive and :accuracy_strict strategies.

​
strategy
enum<string> | null
default:historical
Available options:
historical,
naive,
accuracy_strict
​
delay_seconds
integer | null

Only valid for :naive and :accuracy_strict strategies

​
geofences
Geofence-Data · object[] | null

Inline geofence definitions to use instead of the job's default geofences. Only used for :naive and :accuracy_strict strategies.

Response

OK

​
data
GeofenceTrigger-Read · object[]
required