Skip to main content
POST
/
kpis
/
objects
curl --request POST \
  --url https://api.inorbit.ai/kpis/objects \
  --header 'Content-Type: application/json' \
  --header 'x-auth-inorbit-app-key: <api-key>' \
  --data '
{
  "objectType": "mission",
  "startTime": 1717200000000,
  "endTime": 1719800000000,
  "offset": 0,
  "limit": 20
}
'
{
  "data": [
    {
      "type": "mission",
      "companyId": "company-123",
      "id": "mission-001",
      "entity": "robot-001",
      "startTs": 1717200000000,
      "endTs": 1717203600000,
      "data": {
        "duration": 3600,
        "status": "completed",
        "robotData": {
          "location": "warehouse-a"
        }
      }
    },
    {
      "type": "incident",
      "companyId": "company-123",
      "id": "incident-001",
      "entity": "robot-002",
      "startTs": 1717200000000,
      "endTs": 1717201800000,
      "data": {
        "severity": "high",
        "description": "Navigation error"
      }
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 20,
    "hasMore": false
  }
}

Documentation Index

Fetch the complete documentation index at: https://inorbitinc.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-auth-inorbit-app-key
string
header
required

InOrbit appKey authenticates API requests using a token.

You can obtain your appKey in the Authentication docs.

Body

application/json
objectType
string
required

KPI object type (e.g., mission, incident, order)

startTime
integer<int64>
required

Start timestamp in milliseconds

endTime
integer<int64>
required

End timestamp in milliseconds

limit
integer
required

Maximum number of records to return

Required range: 1 <= x <= 100
offset
integer
required

Number of records to skip

Required range: x >= 0
filters
object[]

Optional filters to apply on fields

orderBy
string

Field to order results by

Response

List of KPI objects

data
object[]
required

Array of KPI objects

pagination
object
required