Retrieve partner operational statistics

Retrieve the operational statistics of a partner’s devices and organizations. Only partners can make this call.

Request

Security:

query Parameters

months	integer (Months) [ 0 .. 36 ] Default: 1 The number of previous months to include in the statistical trends. The current month is included by default. Example: months=2
weeks	integer (Weeks) [ 0 .. 156 ] Default: 1 The number of previous weeks to include in the statistical trends. The current week is included by default. Example: weeks=5

Responses

200

Successful operation

400

Bad request error

401

Unauthorized error

403

Forbidden error

404

Not found error

500

Internal server error

get/partners/operational-statistics

Request samples

curl
JavaScript
Node.js

curl -i -X GET \
  'https://api-prod.surfsight.net/v2/partners/operational-statistics?months=2&weeks=5' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Response samples

application/json

{"data": {"devices": {"total": 53,
"activated": 43,
"deactivated": 10,
"pendingActivation": 10,
"suspended": 10
},
"trends": {"activations": {"total": 53,
"previousMonths": [{"monthsAgo": 2,
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"count": 1
}
],
"previousWeeks": [{"weeksAgo": 2,
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"count": 1
}
]
},
"organizations": {"total": 53,
"previousMonths": [{"monthsAgo": 2,
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"count": 1
}
],
"previousWeeks": [{"weeksAgo": 2,
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"count": 1
}
]
}
},
"devicesByOrganization": [{"organizationId": 17,
"name": "Company Name",
"count": 53
}
],
"recordingHealthFailedByOrganization": [{"organizationId": 17,
"name": "Company Name",
"count": 1
}
],
"recordingHealthSummary": [{"recordingTestResult": "passed",
"count": 27
}
],
"alarmsByOrganization": [{"organizationId": 17,
"name": "Company Name",
"count": 1
}
],
"alarmsByType": [{"alarmDefinitionId": 625,
"name": "Driver dashcam recording failure",
"count": 1
}
]
},
"requestId": "06327cae-e075-42ca-b620-c5cfdd3b4e37"
}