This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
Gets clipped Observation histories along each Geotime Track matching the supplied query. Histories are clipped based on the supplied time window. Only returns Observations conforming to the given Observation Spec.
stringSearch results will be constrained to Observations conforming to this Observation Spec.
booleanRepresents a boolean value that restricts an endpoint to preview mode when set to true.
objectobjectThe query to match to Geotime Tracks.
objectThe time range over which Geotime Tracks with most recent Observations with timestamps falling within this inclusive range will be matched to.
stringstringlist<GeoPoint>The polygon within which to search for Geotime Tracks. The polygon must be structured in the following manner:
objectnumbernumbernumberobjectMatches observations which have any of the values specified for this property.
stringThe name of the property in the observation schema
list<PropertyValue>anyRepresents the value of a property. The following table provides expected representations of scalar data types:
| Type | JSON encoding | Example |
|---|---|---|
| Date | ISO 8601 extended local date string | "2021-05-01" |
| Decimal | string | "2.718281828" |
| Double | number | 3.14159265 |
| Integer | number | 238940 |
| Long | string | "58319870951433" |
| String | string | "Call me Ishmael" |
| Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
objectThe time range over which Geotime Tracks with most recent Observations with timestamps falling within this inclusive range will be matched to.
stringstringstringThe page token indicates where to start paging. This should be omitted from the first page's request.
To fetch the next page, clients should take the value from the nextPageToken field of the previous response
and populate the next request's pageToken field with it.
objectSuccess response
list<Track>objectA series of timestamped Observations.
stringGlobally unique identifier for a Geotime Track. This is synonymous with a Gotham Identifier and contains information like SourceSystemId, CollectionId, SpecId and TrackId.
list<Observation>objectA geotemporal object along a Geotime Track (SSID, CID, SpecID, TrackID quadruplet).
stringGlobally unique identifier for the system from which this Observation data is sourced. An example might be the name of a database.
stringIdentifier for the specific data source within the source system for this Observation data. This is a mandatory qualifier in addition to the Source System ID, and is unique within the source system. To extend the above example, this would identify a specific table within the database.
stringGlobally unique identifier for the Observation Specification. Observation Specs are schemas used to define the shape of an Observation. These schemas contain mandatory fields such as timestamp, position and Track ID, as well as dynamically defined fields exposed as static and live properties.
stringThe ID of a series of location points. This is a shared ID between Observations which forms a Track. These IDs are typically derived from the integrated data. For example, a flight identifier used to distinguish a unique voyage by a plane.
objectnumbernumbernumberstringstringThe name of the entity associated with the Observation. For example, 'My Plane' or 'Air Force One'.
list<ObservationField>Properties that are expected to remain constant along a Geotime Track. E.g. A plane's tail number.
objectA dynamic field that must match a field defined in the Observation's associated ObservationSpec.
stringanyA string that can represent a plain string, GeoJson string, or numeric value.
list<ObservationField>Properties that are expected to be updated frequently along a Geotime Track. E.g. A plane's heading.
objectA dynamic field that must match a field defined in the Observation's associated ObservationSpec.
stringanyA string that can represent a plain string, GeoJson string, or numeric value.
objectDescribes styling information about how an individual observation should be displayed on the frontend.
stringThe name of an icon from the open source project "blueprint" to be used in the baseball card view of an observation.
unionAn identifier for a symbology icon to use for display on a map.
objectA built-in generic icon identifier. The color properties, if specified, must be a 6-character hexadecimal string describing the color to use for the icon. The leading # is required.
stringThe code of an icon allowed on a given deployment.
stringA 6-character hexadecimal string describing the color to use to fill the icon (if supported). The leading # is required.
stringA 6-character hexadecimal string describing the color to use for the icon's stroke (if supported). The leading # is required.
objectA builtin set of identifiers that are built-in and follow the MIL-STD-2525 specification.
stringobjectDescribes styling information to control the appearance of observation geometry.
numberstringA 6 character hexadecimal string describing the color of the border on all geometry. Default is "#FDFF00". The leading # is required.
stringA 6 character hexadecimal string describing the color to fill all geometry. The leading # is required. By default, the geometry will not be filled and will instead appear "hollow". If you want to fill a geometry, you must specify both fillColor and fillOpacity for this to have any effect.
numberA number between 0 and 1 (inclusive) which controls the opacity of the fill of all geometry. By default, this is 0. If you want to fill a geometry, you must specify both fillColor and fillOpacity for this to have any effect.
stringThe page token indicates where to start paging. This should be omitted from the first page's request.
To fetch the next page, clients should take the value from the nextPageToken field of the previous response
and populate the next request's pageToken field with it.
1
2
3
4
5
curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/gotham/v1/observations/history/baz/search?preview=true" \
-d '{"query":{"time":{"start":"2023-01-01T12:00:00Z","end":"2023-03-07T12:10:00Z"},"historyWindow":{"start":"2023-03-07T12:00:00Z","end":"2023-03-07T12:10:00Z"}}}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
{
"data": {
"trackRid": "ri.gotham-1.1.foo.bar.baz.track0",
"observations": [
{
"sourceSystemId": "foo",
"collectionId": "bar",
"observationSpecId": "baz",
"trackId": "track0",
"position": {
"longitude": 0,
"latitude": 0
},
"timestamp": "2023-03-05T17:00:00Z",
"name": "name0",
"staticProperties": [],
"liveProperties": []
},
{
"sourceSystemId": "foo",
"collectionId": "bar",
"observationSpecId": "baz",
"trackId": "track0",
"position": {
"longitude": 11,
"latitude": 1
},
"timestamp": "2023-03-05T17:10:00Z",
"name": "name0",
"staticProperties": [],
"liveProperties": []
}
]
}
}