• Geo
  • getDevice Geo position
  • getDevice Geo position
  • getGeo Path
  • getGeo Reverse
  • getCount devices with geo position
• Hearbeat
  • getView Heartbeat
  • getView Heartbeat
  • getCount Devices with a heartbeat
• Jobs
  • getList jobs by type
  • getGet job status
  • delDelete job
• Metering
  • getReturns the approximate count of the data points for a specific measurement and its aggregates
  • getReturns current tenant size ( number of data points, disk size )
• SmartInsights
  • getGet latest correlation profile
  • getUpdate correlation profile
  • getGet latest quantile profile
• Tags
  • getFind tags
  • getFind by device id
  • getFind Tag by TagId
• Timeseries
  • postRead a device Snapshot values (last values)
• Snapshots
  • postSnapshot query for multiple ids
  • getRead a device Snapshot values (last values)
  • getRead a device Snapshot values (last values)

API docs by Redocly

Nimbit Query Engine (1.0)

Download OpenAPI specification:Download

Nimbit support: iot@nimbit.de URL: https://www.nimbit.de License: Apache 2.0

Nimbit IoT query engine.

OpenAPI

Geo

Device Geo position

GetForRange geo position for all devices

query Parameters

measurement

string measurement

Responses

https://cparsinnovationlab.bitbucket.io/api/v1/geo

Response samples

• 200

Content type

application/json

[

• {

  • "altitude": 0,
  • "distanceTraveled": 0,
  • "heading": 0,
  • "id": "string",
  • "lastUpdate": 0,
  • "lat": 0,
  • "lon": 0,
  • "measurement": "string",
  • "online": true,
  • "speed": 0,
  • "tags": { },
  • "time": 0

  }

]

Device Geo position

GetForRange geo position for device

path Parameters

id required

string id

query Parameters

measurement	string measurement
fields	string Comma separated list of fields(will limit the response)
reverse	boolean Geo reverse
lang	string Address language

Responses

https://cparsinnovationlab.bitbucket.io/api/v1/geo/{id}

Response samples

• 200

Content type

application/json

{

• "altitude": 0,
• "distanceTraveled": 0,
• "geoReverse": {

  • "city": "string",
  • "country": "string",
  • "countryCode": "string",
  • "fullAddress": "string",
  • "houseNumber": "string",
  • "id": "string",
  • "lat": 0,
  • "lon": 0,
  • "measurement": "string",
  • "postalCode": "string",
  • "street": "string",
  • "time": 0

  },
• "heading": 0,
• "id": "string",
• "lastUpdate": 0,
• "lat": 0,
• "lon": 0,
• "measurement": "string",
• "online": true,
• "speed": 0,
• "tags": { },
• "time": 0

}

Geo Path

Geo Path

path Parameters

id required

string id

query Parameters

measurement	string measurement
start required	integer Start time Epoch in miliseconds
end required	integer End time Epoch in miliseconds
limit	integer End time Epoch in miliseconds
meters	integer Used to filter most relevant data points representing movement. Only values where a move greater or equal to the desired meters will be shown
includeCurrentPosition	boolean Used to filter most relevant data points representing movement. Only values where a move greater or equal to the desired meters will be shown

Responses

https://cparsinnovationlab.bitbucket.io/api/v1/geo/{id}/path

Response samples

• 200

Content type

application/json

{

• "currentPosition": {

  • "altitude": 0,
  • "distanceTraveled": 0,
  • "heading": 0,
  • "id": "string",
  • "lastUpdate": 0,
  • "lat": 0,
  • "lon": 0,
  • "measurement": "string",
  • "online": true,
  • "speed": 0,
  • "tags": { },
  • "time": 0

  },
• "points": [

  • {

    • "altitude": 0,
    • "distanceTraveled": 0,
    • "heading": 0,
    • "id": "string",
    • "lastUpdate": 0,
    • "lat": 0,
    • "lon": 0,
    • "measurement": "string",
    • "online": true,
    • "speed": 0,
    • "tags": { },
    • "time": 0

    }

  ],
• "totalPoints": 0

}

Geo Reverse

Geo Reverse (address)

path Parameters

id required

string id

query Parameters

measurement	string measurement
lang	string Address language

Responses

https://cparsinnovationlab.bitbucket.io/api/v1/geo/{id}/reverse

Response samples

• 200

Content type

application/json

{

• "city": "string",
• "country": "string",
• "countryCode": "string",
• "fullAddress": "string",
• "houseNumber": "string",
• "id": "string",
• "lat": 0,
• "lon": 0,
• "measurement": "string",
• "postalCode": "string",
• "street": "string",
• "time": 0

}

Count devices with geo position

Count devices with geo position

query Parameters

measurement

string measurement

Responses

https://cparsinnovationlab.bitbucket.io/api/v1/geo/count

Hearbeat

View Heartbeat

View Hearbeat for all devices

query Parameters

measurement

string measurement

Responses

https://cparsinnovationlab.bitbucket.io/api/v1/heartbeat

Response samples

• 200

Content type

application/json

[

• {

  • "geo": {

    • "lastUpdate": 0,
    • "lat": 0,
    • "lon": 0

    },
  • "id": "string",
  • "lastUpdate": 0,
  • "measurement": "string",
  • "online": true

  }

]

View Heartbeat

View Hearbeat for all device

path Parameters

id required

string id

query Parameters

measurement

string measurement

Responses

https://cparsinnovationlab.bitbucket.io/api/v1/heartbeat/{id}

Response samples

• 200

Content type

application/json

{

• "geo": {

  • "lastUpdate": 0,
  • "lat": 0,
  • "lon": 0

  },
• "id": "string",
• "lastUpdate": 0,
• "measurement": "string",
• "online": true

}

Count Devices with a heartbeat

Count Devices with a heartbeat

query Parameters

measurement

string measurement

Responses

https://cparsinnovationlab.bitbucket.io/api/v1/heartbeat/count

Jobs

List jobs by type

List all background jobs of a specific type

query Parameters

type required

string Enum: "correlation_update" "quantile_update" job type

Responses

https://cparsinnovationlab.bitbucket.io/api/v1/jobs

Response samples

• 200

Content type

application/json

[

• {

  • "completed_at": "string",
  • "created_at": "string",
  • "error_message": "string",
  • "id": "string",
  • "measurement": "string",
  • "processed_rows": 0,
  • "progress": 0,
  • "schema": "string",
  • "started_at": "string",
  • "status": "pending",
  • "total_rows": 0,
  • "type": "correlation_update",
  • "updated_at": "string"

  }

]

Get job status

Get status of a background job

path Parameters

id required

string job ID

Responses

https://cparsinnovationlab.bitbucket.io/api/v1/jobs/{id}

Response samples

• 200

Content type

application/json

{

• "completed_at": "string",
• "created_at": "string",
• "error_message": "string",
• "id": "string",
• "measurement": "string",
• "processed_rows": 0,
• "progress": 0,
• "schema": "string",
• "started_at": "string",
• "status": "pending",
• "total_rows": 0,
• "type": "correlation_update",
• "updated_at": "string"

}

Delete job

Delete a background job

path Parameters

id required

string job ID

Responses

https://cparsinnovationlab.bitbucket.io/api/v1/jobs/{id}

Response samples

• 204

Content type

application/json

"string"

Metering

Returns the approximate count of the data points for a specific measurement and its aggregates

Returns the approximate count of the data points for a specific measurement and its aggregates

path Parameters

measurement required

string measurement

query Parameters

startDate	string Start Date
endDate	string End Date

Responses

https://cparsinnovationlab.bitbucket.io/api/v1/metering/size/measurement/{measurement}

Response samples

• 200

Content type

application/json

{

• "aggregations": [

  • {

    • "byteSize": 0,
    • "interval": "string",
    • "name": "string",
    • "rowCount": 0

    }

  ],
• "byteSize": 0,
• "date": {

  • "time.Time": "string"

  },
• "name": "string",
• "rowCount": 0,
• "tenant": "string"

}

Returns current tenant size ( number of data points, disk size )

Returns the approximate count of the data points and disk size the current tenant

query Parameters

startDate	string Start Date
endDate	string End Date

Responses

https://cparsinnovationlab.bitbucket.io/api/v1/metering/size/tenant

Response samples

• 200

Content type

application/json

{

• "byteSize": 0,
• "date": {

  • "time.Time": "string"

  },
• "measurements": [

  • {

    • "byteSize": 0,
    • "name": "string",
    • "rowCount": 0

    }

  ],
• "rowCount": 0,
• "tenant": "string"

}

SmartInsights

Get latest correlation profile

Get latest correlation profile

path Parameters

measurement required

string measurement

Responses

https://cparsinnovationlab.bitbucket.io/api/v1/smartinsights/correlation/{measurement}

Response samples

• 200

Content type

application/json

{

• "correlations": [

  • [

    • 0

    ]

  ],
• "measures": [

  • "string"

  ],
• "sampleCounts": [

  • 0

  ]

}

Update correlation profile

Trigger correlation profile update

path Parameters

measurement required

string measurement

Responses

https://cparsinnovationlab.bitbucket.io/api/v1/smartinsights/correlation/{measurement}/update

Response samples

• 204

Content type

application/json

"string"

Get latest quantile profile

Get latest quantile profile

path Parameters

measurement required

string measurement

Responses

https://cparsinnovationlab.bitbucket.io/api/v1/smartinsights/quantile/{measurement}

Response samples

• 200

Content type

application/json

[

• {

  • "bucketSize": 0,
  • "endTime": "string",
  • "errors": 0,
  • "measure": "string",
  • "measurement": "string",
  • "p10": 0,
  • "p25": 0,
  • "p50": 0,
  • "p75": 0,
  • "p90": 0,
  • "startTime": "string",
  • "totalValues": 0,
  • "updatedAt": "string"

  }

]

Tags

Find tags

Find Tag by Tag ID

query Parameters

measurement	string measurement
limit	integer Page limit default 200
page	integer Page number
tags	string Tag values (key-value pairs)

Responses

https://cparsinnovationlab.bitbucket.io/api/v1/tags

Response samples

• 200

Content type

application/json

{

• "count": 1000,
• "data": [

  • {

    • "id": "string",
    • "measurement": "string",
    • "tagId": "string",
    • "tags": {

      • "property1": "string",
      • "property2": "string"

      }

    }

  ],
• "limit": 0,
• "page": 0,
• "pageCount": 0

}

Find by device id

Find Tag by device id

path Parameters

id required

string Device id

query Parameters

tags	string Tag values (key-value pairs)
limit	integer Page limit default 200
page	integer Page number

Responses

https://cparsinnovationlab.bitbucket.io/api/v1/tags/byId/{id}

Response samples

• 200

Content type

application/json

{

• "count": 1000,
• "data": [

  • {

    • "id": "string",
    • "measurement": "string",
    • "tagId": "string",
    • "tags": {

      • "property1": "string",
      • "property2": "string"

      }

    }

  ],
• "limit": 0,
• "page": 0,
• "pageCount": 0

}

Find Tag by TagId

Find Tag by Tag ID

path Parameters

tag_id required

integer Tag ID

Responses

https://cparsinnovationlab.bitbucket.io/api/v1/tags/byTagId/{tag_id}

Response samples

• 200

Content type

application/json

{

• "id": "string",
• "measurement": "string",
• "tagId": "string",
• "tags": {

  • "property1": "string",
  • "property2": "string"

  }

}

Timeseries

Read a device Snapshot values (last values)

The snapshot endpoint will per default return the last value for all properties available for a thing. Use the fields parameter to send a comma separated list of fields of only specific fields are required.

Request Body schema: application/json

required

Timeseries Query

gapFill	string Enum: "none" "time" "locf" "interpolate"
required	Array of objects (nbq_internal_models.Query)
useRaw	boolean Default: false
required	object (nbq_internal_models.Window)

Responses

https://cparsinnovationlab.bitbucket.io/api/v1/timeseries

Request samples

• Payload

Content type

application/json

{

• "gapFill": { },
• "queries": [

  • {

    • "aggregations": [

      • "min"

      ],
    • "end": { },
    • "id": "string",
    • "includeTags": true,
    • "max": 0,
    • "measure": "string",
    • "measureType": "numeric",
    • "measurement": "string",
    • "min": 0,
    • "precision": 0,
    • "queryId": "string",
    • "start": { },
    • "tags": {

      • "property1": "string",
      • "property2": "string"

      }

    }

  ],
• "useRaw": false,
• "window": {

  • "bucketSize": { },
  • "end": { },
  • "shiftWindow": true,
  • "start": { },
  • "timeZone": "string"

  }

}

Response samples

• 200

Content type

application/json

[

• {

  • "id": "string",
  • "lastUpdate": 0,
  • "measurement": "string",
  • "online": true,
  • "tagId": "string",
  • "values": [

    • {

      • "dataType": "string",
      • "id": "string",
      • "measure": "string",
      • "tags": { },
      • "time": 0,
      • "value": { }

      }

    ]

  }

]

Snapshots

Snapshot query for multiple ids

An array if queries can be provided containing the desired id measurement and snapshot fields if the measure and id are found the values are returned

Request Body schema: application/json

required

Snapshot Query

Array

id	string
measurement	string
measures	Array of strings
queryId	string
	object
type	string
updatesOnly	boolean
version	string

Responses

https://cparsinnovationlab.bitbucket.io/api/v1/timeseries/snapshot

Request samples

• Payload

Content type

application/json

[

• {

  • "id": "string",
  • "measurement": "string",
  • "measures": [

    • "string"

    ],
  • "queryId": "string",
  • "tags": {

    • "property1": "string",
    • "property2": "string"

    },
  • "type": "string",
  • "updatesOnly": true,
  • "version": "string"

  }

]

Response samples

• 200

Content type

application/json

[

• {

  • "id": "string",
  • "lastUpdate": 0,
  • "measurement": "string",
  • "online": true,
  • "queryId": "string",
  • "values": [

    • {

      • "measure": "string",
      • "tags": { },
      • "time": 0,
      • "value": { }

      }

    ]

  }

]

Read a device Snapshot values (last values)

The snapshot endpoint will per default return the last value for all properties available for a thing. Use the fields parameter to send a comma separated list of fields of only specific fields are required.

path Parameters

id required

string Device id

query Parameters

measurement	string measurement name
fields	string comma separated list of fields
tags	string Tag values (key-value pairs)

Responses

https://cparsinnovationlab.bitbucket.io/api/v1/timeseries/snapshot/{id}

Response samples

• 200

Content type

application/json

{

• "id": "string",
• "lastUpdate": 0,
• "measurement": "string",
• "online": true,
• "tagId": "string",
• "values": [

  • {

    • "dataType": "string",
    • "id": "string",
    • "measure": "string",
    • "tags": { },
    • "time": 0,
    • "value": { }

    }

  ]

}

Read a device Snapshot values (last values)

The snapshot endpoint will per default return the last value for all properties available for a thing. Use the fields parameter to send a comma separated list of fields of only specific fields are required.

path Parameters

ids required

string Device ids (comma separated)

query Parameters

measurement	string measurement name
fields	string comma separated list of fields
tags	string Tag values (key-value pairs)

Responses

https://cparsinnovationlab.bitbucket.io/api/v1/timeseries/snapshotlist/{ids}

Response samples

• 200

Content type

application/json

[

• {

  • "id": "string",
  • "lastUpdate": 0,
  • "measurement": "string",
  • "online": true,
  • "tagId": "string",
  • "values": [

    • {

      • "dataType": "string",
      • "id": "string",
      • "measure": "string",
      • "tags": { },
      • "time": 0,
      • "value": { }

      }

    ]

  }

]