MImirurobotics
Calibrations

List

List calibrations. By default, results are ordered by created_at descending, with ties broken by id.

get/calibrations

Request

  • Base URL
    https://api.mirurobotics.com/beta
  • URL
    https://api.mirurobotics.com/beta/calibrations
  • Auth
    API key in header X-API-Key

Query parameters

offsetinteger

The offset of the items to return. An offset of 10 with a limit of 10 returns items 11-20.

limitinteger
Example:10

The maximum number of items to return. A limit of 15 with an offset of 0 returns items 1-15.

order_byCalibrationOrderBy[]

Sort order for the calibration results.

[
  "created_at:desc"
]
expandCalibrationListExpansion[]

Fields to expand on each calibration in the list.

[
  "content"
]
device_idstring[]

The device IDs to filter by.

[
  "dvc_123"
]
componentstring[]

The component slugs to filter by.

[
  "arm"
]
rolestring[]

The role slugs to filter by. Role slugs are unique only within a component, so filter by component too to match one component's role.

[
  "front-left"
]
aspectstring[]

The aspect slugs to filter by. Aspect slugs are unique only within a component, so filter by component too to match one component's aspect.

[
  "pose"
]
serial_numberstring[]

The unit serial numbers to filter by.

[
  "SN-1234"
]
report_idstring[]

The report IDs to filter by.

[
  "0b6f3c2e-6a51-4e0f-9a43-2f1d7c9e8b10"
]

Response

Successfully listed the calibrations.

object'list' required

The object type, which is always list.

total_countinteger

The total number of items in the list. By default the total count is not returned. The total count must be expanded (using expand=total_count) to get the total number of items in the list.

limitinteger required

The maximum number of items to return. A limit of 15 with an offset of 0 returns items 1-15.

offsetinteger required

The offset of the items to return. An offset of 10 with a limit of 10 returns items 11-20.

has_moreboolean required

True if there are more items in the list to return. False if there are no more items to return.

Example response

{
  "object": "list",
  "data": [
    {
      "object": "calibration",
      "id": "cal_123",
      "device_id": "dvc_123",
      "component": "arm",
      "role": "front-left",
      "aspect": null,
      "serial_number": "SN-1234",
      "digest": "sha256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
      "report_id": "0b6f3c2e-6a51-4e0f-9a43-2f1d7c9e8b10",
      "reported_at": "2021-01-01T00:00:00Z",
      "created_at": "2021-01-01T00:00:00Z",
      "content": {
        "format": "json",
        "data": "{\n  \"x\": 0.412,\n  \"y\": -0.087,\n  \"z\": 0.256,\n  \"roll\": 0.0,\n  \"pitch\": 0.0,\n  \"yaw\": 1.571\n}\n"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.