Inventory allocations
Group and count inventory allocations
POST
/
inventory-allocation
/
group-and-count
Group and count inventory allocations
curl --request POST \
--url https://{instance}/api/v2/inventory-allocation/group-and-count \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"groupByField": "<string>",
"unnestGroupByField": true
}
'const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({groupByField: '<string>', unnestGroupByField: true})
};
fetch('https://{instance}/api/v2/inventory-allocation/group-and-count', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{instance}/api/v2/inventory-allocation/group-and-count"
payload = {
"groupByField": "<string>",
"unnestGroupByField": True
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"values": [
{
"groupId": "<unknown>",
"count": 123
}
],
"hasMore": true
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}Authorizations
Organization-scoped API key. Create one in the BuildingSwell app under Organization settings, API keys.
Body
application/json
Field to group by, or several fields for a compound grouping. Nested paths work, for example computed.projectId.
Set this when grouping by an array field, such as computed.tags, to count each value separately instead of counting whole arrays.
⌘I
Group and count inventory allocations
curl --request POST \
--url https://{instance}/api/v2/inventory-allocation/group-and-count \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"groupByField": "<string>",
"unnestGroupByField": true
}
'const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({groupByField: '<string>', unnestGroupByField: true})
};
fetch('https://{instance}/api/v2/inventory-allocation/group-and-count', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{instance}/api/v2/inventory-allocation/group-and-count"
payload = {
"groupByField": "<string>",
"unnestGroupByField": True
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"values": [
{
"groupId": "<unknown>",
"count": 123
}
],
"hasMore": true
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}