GET api/v1/measurements/{deviceId}/{channel}?startDate={startDate}&endDate={endDate}&limit={limit}&sortOrder={sortOrder}

Get measurements for the specified device/user.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
deviceId

The device.

globally unique identifier

Required

channel

The measurements channel.

integer

Default value is 0

startDate

Read results starting from this date.

string

Default value is

endDate

The end date of the results to read.

string

Default value is

limit

How many results to request. This is limited to 1000 maximum. Start and End date should be used for pagination

integer

Default value is 1000

sortOrder

Sort order. Asc or Desc

SortOrder

Default value is Asc

Body Parameters

None.

Response Information

Resource Description

Collection of MeasurementResponseDto
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

Url

Do not use. Use Links["self"]

string

None.

PostedOn

date

None.

MeasurementDate

date

None.

MeasurementFields

Collection of fields for this measurement point.

Collection of FieldDto

None.

MeasurementDateEpoch

Used for charting.

decimal number

None.

Links

Collection of links associated with the measurement.

Collection of LinkDto

None.

Actions

Actionable links for the measurement (e.g. delete, tag)

Collection of LinkDto

None.

Tags

Freeform Tags assigned to the measurement (e.g. Calibration or QC)

Collection of string

None.

SampleId

Sample Id assigned to the measurement.

string

None.

Location

Location the measurement was taken.

LocationDto

None.

OperatorId

Operator Id taking the measurement

string

None.

BatteryLevelPercentage

Battery level recorded with the measurement. If Appropriate.

integer

None.

RfStrength

RF Signal strength recorded with the measurement. If Appropriate.

integer

None.

Response Formats

application/json, text/json, application/senml+json

Sample:
[
  {
    "Id": "5e52f2d3-83ad-4592-a10a-cffbab4c5766",
    "Url": "sample string 2",
    "PostedOn": "2024-04-18T07:30:15.7418836+00:00",
    "MeasurementDate": "2024-04-18T07:30:15.7418836+00:00",
    "Field1": "sample string 5",
    "Field2": "sample string 6",
    "Field3": "sample string 7",
    "Field4": "sample string 8",
    "Field5": "sample string 9",
    "Field6": "sample string 10",
    "Field7": "sample string 11",
    "Field8": "sample string 12",
    "Field9": "sample string 13",
    "Field10": "sample string 14",
    "Field11": "sample string 15",
    "Field12": "sample string 16",
    "Fields": [],
    "MeasurementFields": [],
    "MeasurementDateEpoch": 1713425415.7418835,
    "Links": [
      {
        "Href": "sample string 1",
        "Rel": "sample string 2",
        "Action": "sample string 3"
      },
      {
        "Href": "sample string 1",
        "Rel": "sample string 2",
        "Action": "sample string 3"
      }
    ],
    "Actions": [
      {
        "Href": "sample string 1",
        "Rel": "sample string 2",
        "Action": "sample string 3"
      },
      {
        "Href": "sample string 1",
        "Rel": "sample string 2",
        "Action": "sample string 3"
      }
    ],
    "Tags": [
      "sample string 1",
      "sample string 2"
    ],
    "SampleId": "sample string 17",
    "Location": {
      "Name": "sample string 1",
      "Latitude": 2.1,
      "Longitude": 3.1,
      "Elevation": 4.1,
      "WellKnownLocationId": "7f1aecf0-1553-464a-ab7d-cb7c66a79d3b",
      "LastUpdated": "2024-04-18T07:30:15.7418836+00:00"
    },
    "OperatorId": "sample string 18",
    "BatteryLevelPercentage": 1,
    "RfStrength": 1
  },
  {
    "Id": "5e52f2d3-83ad-4592-a10a-cffbab4c5766",
    "Url": "sample string 2",
    "PostedOn": "2024-04-18T07:30:15.7418836+00:00",
    "MeasurementDate": "2024-04-18T07:30:15.7418836+00:00",
    "Field1": "sample string 5",
    "Field2": "sample string 6",
    "Field3": "sample string 7",
    "Field4": "sample string 8",
    "Field5": "sample string 9",
    "Field6": "sample string 10",
    "Field7": "sample string 11",
    "Field8": "sample string 12",
    "Field9": "sample string 13",
    "Field10": "sample string 14",
    "Field11": "sample string 15",
    "Field12": "sample string 16",
    "Fields": [],
    "MeasurementFields": [],
    "MeasurementDateEpoch": 1713425415.7418835,
    "Links": [
      {
        "Href": "sample string 1",
        "Rel": "sample string 2",
        "Action": "sample string 3"
      },
      {
        "Href": "sample string 1",
        "Rel": "sample string 2",
        "Action": "sample string 3"
      }
    ],
    "Actions": [
      {
        "Href": "sample string 1",
        "Rel": "sample string 2",
        "Action": "sample string 3"
      },
      {
        "Href": "sample string 1",
        "Rel": "sample string 2",
        "Action": "sample string 3"
      }
    ],
    "Tags": [
      "sample string 1",
      "sample string 2"
    ],
    "SampleId": "sample string 17",
    "Location": {
      "Name": "sample string 1",
      "Latitude": 2.1,
      "Longitude": 3.1,
      "Elevation": 4.1,
      "WellKnownLocationId": "7f1aecf0-1553-464a-ab7d-cb7c66a79d3b",
      "LastUpdated": "2024-04-18T07:30:15.7418836+00:00"
    },
    "OperatorId": "sample string 18",
    "BatteryLevelPercentage": 1,
    "RfStrength": 1
  }
]

application/xml, text/xml

Sample:
<ArrayOfMeasurementResponseDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Measurements">
  <MeasurementResponseDto>
    <Actions xmlns:d3p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared">
      <d3p1:LinkViewModel>
        <d3p1:Action>sample string 3</d3p1:Action>
        <d3p1:Href>sample string 1</d3p1:Href>
        <d3p1:Rel>sample string 2</d3p1:Rel>
      </d3p1:LinkViewModel>
      <d3p1:LinkViewModel>
        <d3p1:Action>sample string 3</d3p1:Action>
        <d3p1:Href>sample string 1</d3p1:Href>
        <d3p1:Rel>sample string 2</d3p1:Rel>
      </d3p1:LinkViewModel>
    </Actions>
    <BatteryLevelPercentage>1</BatteryLevelPercentage>
    <Field1>sample string 5</Field1>
    <Field10>sample string 14</Field10>
    <Field11>sample string 15</Field11>
    <Field12>sample string 16</Field12>
    <Field2>sample string 6</Field2>
    <Field3>sample string 7</Field3>
    <Field4>sample string 8</Field4>
    <Field5>sample string 9</Field5>
    <Field6>sample string 10</Field6>
    <Field7>sample string 11</Field7>
    <Field8>sample string 12</Field8>
    <Field9>sample string 13</Field9>
    <Fields />
    <Id>5e52f2d3-83ad-4592-a10a-cffbab4c5766</Id>
    <Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared">
      <d3p1:LinkViewModel>
        <d3p1:Action>sample string 3</d3p1:Action>
        <d3p1:Href>sample string 1</d3p1:Href>
        <d3p1:Rel>sample string 2</d3p1:Rel>
      </d3p1:LinkViewModel>
      <d3p1:LinkViewModel>
        <d3p1:Action>sample string 3</d3p1:Action>
        <d3p1:Href>sample string 1</d3p1:Href>
        <d3p1:Rel>sample string 2</d3p1:Rel>
      </d3p1:LinkViewModel>
    </Links>
    <Location xmlns:d3p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared">
      <d3p1:Elevation>4.1</d3p1:Elevation>
      <d3p1:LastUpdated>2024-04-18T07:30:15.7418836+00:00</d3p1:LastUpdated>
      <d3p1:Latitude>2.1</d3p1:Latitude>
      <d3p1:Longitude>3.1</d3p1:Longitude>
      <d3p1:Name>sample string 1</d3p1:Name>
      <d3p1:WellKnownLocationId>7f1aecf0-1553-464a-ab7d-cb7c66a79d3b</d3p1:WellKnownLocationId>
    </Location>
    <MeasurementDate>2024-04-18T07:30:15.7418836+00:00</MeasurementDate>
    <MeasurementFields xmlns:d3p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Measurements.V2" />
    <OperatorId>sample string 18</OperatorId>
    <PostedOn>2024-04-18T07:30:15.7418836+00:00</PostedOn>
    <RfStrength>1</RfStrength>
    <SampleId>sample string 17</SampleId>
    <Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Tags>
    <Url>sample string 2</Url>
  </MeasurementResponseDto>
  <MeasurementResponseDto>
    <Actions xmlns:d3p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared">
      <d3p1:LinkViewModel>
        <d3p1:Action>sample string 3</d3p1:Action>
        <d3p1:Href>sample string 1</d3p1:Href>
        <d3p1:Rel>sample string 2</d3p1:Rel>
      </d3p1:LinkViewModel>
      <d3p1:LinkViewModel>
        <d3p1:Action>sample string 3</d3p1:Action>
        <d3p1:Href>sample string 1</d3p1:Href>
        <d3p1:Rel>sample string 2</d3p1:Rel>
      </d3p1:LinkViewModel>
    </Actions>
    <BatteryLevelPercentage>1</BatteryLevelPercentage>
    <Field1>sample string 5</Field1>
    <Field10>sample string 14</Field10>
    <Field11>sample string 15</Field11>
    <Field12>sample string 16</Field12>
    <Field2>sample string 6</Field2>
    <Field3>sample string 7</Field3>
    <Field4>sample string 8</Field4>
    <Field5>sample string 9</Field5>
    <Field6>sample string 10</Field6>
    <Field7>sample string 11</Field7>
    <Field8>sample string 12</Field8>
    <Field9>sample string 13</Field9>
    <Fields />
    <Id>5e52f2d3-83ad-4592-a10a-cffbab4c5766</Id>
    <Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared">
      <d3p1:LinkViewModel>
        <d3p1:Action>sample string 3</d3p1:Action>
        <d3p1:Href>sample string 1</d3p1:Href>
        <d3p1:Rel>sample string 2</d3p1:Rel>
      </d3p1:LinkViewModel>
      <d3p1:LinkViewModel>
        <d3p1:Action>sample string 3</d3p1:Action>
        <d3p1:Href>sample string 1</d3p1:Href>
        <d3p1:Rel>sample string 2</d3p1:Rel>
      </d3p1:LinkViewModel>
    </Links>
    <Location xmlns:d3p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared">
      <d3p1:Elevation>4.1</d3p1:Elevation>
      <d3p1:LastUpdated>2024-04-18T07:30:15.7418836+00:00</d3p1:LastUpdated>
      <d3p1:Latitude>2.1</d3p1:Latitude>
      <d3p1:Longitude>3.1</d3p1:Longitude>
      <d3p1:Name>sample string 1</d3p1:Name>
      <d3p1:WellKnownLocationId>7f1aecf0-1553-464a-ab7d-cb7c66a79d3b</d3p1:WellKnownLocationId>
    </Location>
    <MeasurementDate>2024-04-18T07:30:15.7418836+00:00</MeasurementDate>
    <MeasurementFields xmlns:d3p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Measurements.V2" />
    <OperatorId>sample string 18</OperatorId>
    <PostedOn>2024-04-18T07:30:15.7418836+00:00</PostedOn>
    <RfStrength>1</RfStrength>
    <SampleId>sample string 17</SampleId>
    <Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Tags>
    <Url>sample string 2</Url>
  </MeasurementResponseDto>
</ArrayOfMeasurementResponseDto>