Skip to main content
POST
/
v1
/
vehicles
/
{vehicle_id}
/
consumptions
/
bulk-delete-by-filters
Bulk Delete Vehicle Consumptions by Filters
const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<x-api-key>',
    'x-organization-id': '<x-organization-id>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({filter_hash: '<string>'})
};

fetch('https://api.dcycle.io/v1/vehicles/{vehicle_id}/consumptions/bulk-delete-by-filters', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "success_count": 123,
  "success_ids": {},
  "failed_count": 123,
  "failed_ids": {},
  "message": "<string>"
}

​
Bulk Delete Vehicle Consumptions by Filters

Delete all consumption records for a specific vehicle that match a set of filter criteria. This endpoint uses a two-step workflow: first fetch the consumption list with filters applied (which returns a filter_hash), then call this endpoint with that hash to confirm you are deleting exactly what you saw.
Permanent Action: Deleting consumption records is permanent and cannot be undone. All associated emissions data will be removed from your organization’s totals.

​
How It Works

  1. Call GET /v1/vehicles/{vehicle_id}/consumptions with your desired filters — the response includes a filter_hash field.
  2. Call this endpoint with the same query filters and pass the filter_hash in the request body.
  3. The API verifies the hash matches the current filter results to prevent stale-data race conditions.

​
Request

​
Path Parameters

​
vehicle_id
uuid
required
The UUID of the vehicle whose consumptions you want to deleteExample: 550e8400-e29b-41d4-a716-446655440000

​
Headers

​
x-api-key
string
required
Your API key for authenticationExample: sk_live_1234567890abcdef
​
x-organization-id
string
required
Your organization UUIDExample: a8315ef3-dd50-43f8-b7ce-d839e68d51fa

​
Body Parameters

​
filter_hash
string
required
The hash returned in the filter_hash field of the consumption list response. Confirms you are deleting exactly the records you saw.Example: "b4c2d3e5f6a7b8c9"

​
Query Parameters

At least one filter parameter is required.
​
status[]
array[string]
Filter by consumption statusAvailable values: active, success, loading, errorExample: status[]=error&status[]=loading
​
unit_id[]
array[string]
Filter by unit UUIDs
​
custom_id
string
Filter by custom identifier
​
start_date
string
Filter consumptions with a start date on or after this date (YYYY-MM-DD)Example: 2024-01-01
​
end_date
string
Filter consumptions with an end date on or before this date (YYYY-MM-DD)Example: 2024-12-31
​
file_id[]
array[string]
Filter by source file UUIDs (e.g. to delete all consumptions imported from a specific file)
​
created_at_from
string
Filter consumptions created on or after this datetime (ISO 8601)Example: 2024-01-01T00:00:00Z
​
created_at_to
string
Filter consumptions created on or before this datetime (ISO 8601)Example: 2024-12-31T23:59:59Z
​
co2e_status
string
Filter by CO2e calculation statusAvailable values: calculated, not_calculatedExample: co2e_status=not_calculated

​
Response

Returns 200 OK with a JSON summary of the operation.
​
success_count
integer
Number of consumption records successfully deleted
​
success_ids
array[string]
UUIDs of successfully deleted consumption records
​
failed_count
integer
Number of records that failed to delete
​
failed_ids
array[string]
UUIDs of records that failed to delete
​
message
string
Human-readable summary of the operation

​
Example

# Step 1: get list with filters to obtain filter_hash
curl -X GET "https://api.dcycle.io/v1/vehicles/550e8400-e29b-41d4-a716-446655440000/consumptions?status[]=error" \
  -H "x-api-key: ${DCYCLE_API_KEY}" \
  -H "x-organization-id: ${DCYCLE_ORG_ID}"

# Step 2: bulk delete using the filter_hash from the list response
curl -X POST "https://api.dcycle.io/v1/vehicles/550e8400-e29b-41d4-a716-446655440000/consumptions/bulk-delete-by-filters?status[]=error" \
  -H "x-api-key: ${DCYCLE_API_KEY}" \
  -H "x-organization-id: ${DCYCLE_ORG_ID}" \
  -H "Content-Type: application/json" \
  -d '{"filter_hash": "b4c2d3e5f6a7b8c9"}'

​
Successful Response

{
  "success_count": 8,
  "success_ids": [
    "660e8400-e29b-41d4-a716-446655440000",
    "770e8400-e29b-41d4-a716-446655440001"
  ],
  "failed_count": 0,
  "failed_ids": [],
  "message": "Successfully deleted 8 vehicle consumptions"
}

​
Common Errors

​
401 Unauthorized

Cause: Missing or invalid API key 
{
  "detail": "Invalid API key",
  "code": "INVALID_API_KEY"
}

​
404 Not Found

Cause: Vehicle not found in organization 
{
  "code": "VEHICLE_NOT_FOUND",
  "detail": "Vehicle with id=UUID('...') not found"
}

​
409 Conflict — Filter Hash Mismatch

Cause: The filter_hash does not match the current filter results. The underlying data changed between the list call and the delete call. 
{
  "detail": "Filter hash mismatch. The filters have changed since the list was loaded. Please refresh and try again."
}
Solution: Re-fetch the consumption list with the same filters to get a fresh filter_hash, then retry.

​
422 Unprocessable Entity — No Filters Provided

Cause: No filter query parameters were supplied. At least one filter is required to prevent accidental mass deletion. 
{
  "detail": "At least one filter parameter is required for bulk delete by filters."
}

​
422 Validation Error

Cause: Invalid query parameter value (e.g. unknown status enum) 
{
  "detail": [
    {
      "loc": ["query", "status[]"],
      "msg": "value is not a valid enumeration member; permitted: 'active', 'success', 'loading', 'error'",
      "type": "type_error.enum"
    }
  ]
}

Vehicle Consumptions

List consumptions and obtain the filter_hash

Bulk Delete Consumptions

Delete specific consumption records by ID

Bulk Delete Vehicles by Filters

Delete vehicles matching filter criteria

Delete Vehicle

Delete a single vehicle