Service Count Metrics
GET
/api/v1/inventory/services/countsInventoryReturns service metrics like vendor counts, service type counts, and total accounts.
Auth Scope
urn:grt:inventoryContent-Type
application/jsonRate Limit
60 req/min
Headers
| Header | Value |
|---|---|
Authorization | Bearer access-token |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
granted_tenant_macnum | string | No | The company macnum on whose behalf the action is performed |
Response
Success Response (200 OK)
Response Fields
| Field | Type | Description |
|---|---|---|
total_records | integer | The total number of records found in the dataset |
vendors | object | An object containing a count of records associated with each standardized vendor name. Each key is the vendor name (string), and the value is the record count (integer) |
raw_vendors | object | An object containing a count of records associated with each raw vendor name. Each key is the vendor name (string), and the value is the record count (integer) |
service_types | object | An object containing a count of records for each service type. Each key is the service type name (string), and the value is the record count (integer) |
total_accounts | integer | The total number of unique accounts in the dataset |
Code Examples
Errors
| HTTP Status | Error Description | Resolution |
|---|---|---|
401 | Authentication Failed | Verify your access token is valid and included in the Authorization header with the "Bearer " prefix. |
403 | Permission Denied | Your access token does not have the required scope (urn:grt:inventory). Contact your administrator to request the appropriate permissions. |
Last updated on