Get Logistics Summary
const options = {
method: 'GET',
headers: {'x-api-key': '<x-api-key>', 'x-organization-id': '<x-organization-id>'}
};
fetch('https://api.dcycle.io/v1/logistics/summary', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.dcycle.io/v1/logistics/summary"
headers = {
"x-api-key": "<x-api-key>",
"x-organization-id": "<x-organization-id>"
}
response = requests.get(url, headers=headers)
print(response.text)curl --request GET \
--url https://api.dcycle.io/v1/logistics/summary \
--header 'x-api-key: <x-api-key>' \
--header 'x-organization-id: <x-organization-id>'{
"requests": {
"count": 123,
"last_updated": {}
},
"recharges": {
"count": 123,
"last_updated": {}
},
"hubs": {
"count": 123,
"last_updated": {}
}
}Get Logistics Summary
Get summary statistics for logistics entities in your organization
GET
/
v1
/
logistics
/
summary
Get Logistics Summary
const options = {
method: 'GET',
headers: {'x-api-key': '<x-api-key>', 'x-organization-id': '<x-organization-id>'}
};
fetch('https://api.dcycle.io/v1/logistics/summary', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.dcycle.io/v1/logistics/summary"
headers = {
"x-api-key": "<x-api-key>",
"x-organization-id": "<x-organization-id>"
}
response = requests.get(url, headers=headers)
print(response.text)curl --request GET \
--url https://api.dcycle.io/v1/logistics/summary \
--header 'x-api-key: <x-api-key>' \
--header 'x-organization-id: <x-organization-id>'{
"requests": {
"count": 123,
"last_updated": {}
},
"recharges": {
"count": 123,
"last_updated": {}
},
"hubs": {
"count": 123,
"last_updated": {}
}
}Get Logistics Summary
Retrieve summary statistics including counts and last updated timestamps for each logistics entity type (requests, recharges, hubs).New API: This endpoint is part of the new API architecture with improved design and maintainability.
Request
Headers
string
required
Your API key for authenticationExample:
sk_live_1234567890abcdefstring
required
Your organization UUIDExample:
a8315ef3-dd50-43f8-b7ce-d839e68d51faQuery Parameters
string
Filter by project UUID to get project-scoped summaryExample:
a8315ef3-dd50-43f8-b7ce-d839e68d51faResponse
object
object
object
Example
curl -X GET "https://api.dcycle.io/v1/logistics/summary" \
-H "x-api-key: ${DCYCLE_API_KEY}" \
-H "x-organization-id: ${DCYCLE_ORG_ID}"
import requests
import os
api_key = os.getenv("DCYCLE_API_KEY")
org_id = os.getenv("DCYCLE_ORG_ID")
headers = {
"x-api-key": api_key,
"x-organization-id": org_id
}
response = requests.get(
"https://api.dcycle.io/v1/logistics/summary",
headers=headers
)
result = response.json()
print(f"Requests: {result['requests']['count']}")
print(f"Recharges: {result['recharges']['count']}")
print(f"Hubs: {result['hubs']['count']}")
const axios = require('axios');
const apiKey = process.env.DCYCLE_API_KEY;
const orgId = process.env.DCYCLE_ORG_ID;
const headers = {
'x-api-key': apiKey,
'x-organization-id': orgId
};
axios.get(
'https://api.dcycle.io/v1/logistics/summary',
{ headers }
)
.then(response => {
const { requests, recharges, hubs } = response.data;
console.log(`Requests: ${requests.count}`);
console.log(`Recharges: ${recharges.count}`);
console.log(`Hubs: ${hubs.count}`);
})
.catch(error => console.error(error));
Successful Response
{
"requests": {
"count": 1250,
"last_updated": "2024-11-24T15:30:00Z"
},
"recharges": {
"count": 456,
"last_updated": "2024-11-23T10:15:00Z"
},
"hubs": {
"count": 12,
"last_updated": "2024-11-20T09:00:00Z"
}
}
Common Errors
401 Unauthorized
Cause: Missing or invalid API key{"detail": "Invalid API key for organization", "code": "INVALID_API_KEY"}
403 Forbidden
Cause: The authenticated user is not a member of the organization{"detail": "Logged User is not Member of Organization", "code": "LOGGED_USER_NOT_MEMBER"}
Related Endpoints
Get Logistics Requests
Retrieve logistics shipment requests
Get Logistics Recharges
Retrieve fuel consumption records
Generate Report
Generate ISO 14083 emissions report
Was this page helpful?