Fetch Survey Runs
Retrieve all survey runs for a design. Survey runs represent individual tool runs during drilling — each containing a set of survey measurements taken by a specific tool (e.g. MWD, gyro) over a depth interval.
Survey runs are the building blocks of an actual trajectory. Each run can be tied on to the surface or to a previous run.
GET/api/v1/designs/{designid}/survey-runs
Fetch all survey runs for a design, with computed trajectory points
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
designid | string (UUID) | ✓ | The UUID of the design |
Headers
| Name | Value | Description |
|---|---|---|
apikey | YOUR_API_KEY | Your API authentication key |
Response fields per survey run
| Field | Type | Description |
|---|---|---|
uuid | string | Unique identifier of the survey run |
name | string | Display name (e.g. "Vertical Section", "Build Section") |
tieOnType | "surface" or "run" | Whether this run ties on to the surface or to another run |
tieOnDepth | string | Tie-on depth in pipe-delimited format, e.g. "1000|m" |
tieOnRunUUID | string or null | UUID of the parent run (when tieOnType is "run") |
surveyTool | string | Survey tool/error model name |
points | object | Computed survey points with headers and values |
Understanding tie-ons
Survey runs are chained together via tie-ons:
- Surface tie-on (
tieOnType: "surface") — The first run starts from surface. No parent run needed. - Run tie-on (
tieOnType: "run") — Subsequent runs tie on to the end of a previous run at a specific depth. SettieOnRunUUIDandtieOnDepth.
Notes
- Survey runs only exist on designs with actual (definitive survey) trajectories
- Points are computed server-side with the same calculation engine used for trajectories
- The response uses numeric keys (
"0","1", etc.) for the array of survey runs