Scan Harvest API

Dashboard

Endpoint:http://localhost:8000/api/v1

Get block comparison metrics

GET

http://localhost:8000/api/v1

/farms/{farm_id}/dashboard/blocks/comparison

Get block comparison metrics for specific blocks on a farm for a given date, optionally filtered by unit

Get block comparison metrics › path Parameters

farm_idstring · uuid · required
Farm ID

Get block comparison metrics › query Parameters

datestring · date · required
Date
block_idstring[] · uuid · style: form · explode: true
Block IDs
unitstring
Unit filter

Get block comparison metrics › Responses

Block comparison metrics

block_idstring
block_namestring
fruitsobject[]
total_quantitynumber

Get weekly performance metrics

GET

http://localhost:8000/api/v1

/farms/{farm_id}/dashboard/farm/performance

Get weekly performance metrics for a specific worker and fruit on a farm within a date range

Get weekly performance metrics › path Parameters

farm_idstring · uuid · required
Farm ID

Get weekly performance metrics › query Parameters

start_datestring · date · required
Start date
end_datestring · date · required
End date
worker_idstring · uuid · required
Worker ID
fruit_idstring · uuid · required
Fruit ID

Get weekly performance metrics › Responses

Weekly performance metrics

detailobject[]
end_datestring
fruit_idstring
fruit_namestring
fruit_unitstring
fruit_varietystring
start_datestring
worker_codestring
worker_idstring
worker_namestring

Get average daily harvest speed

GET

http://localhost:8000/api/v1

/farms/{farm_id}/dashboard/farm/speed

Get the average harvest speed across all workers for a specific farm on a given date

Get average daily harvest speed › path Parameters

farm_idstring · uuid · required
Farm ID

Get average daily harvest speed › query Parameters

datestring · date · required
Date
unitstring
Unit filter

Get average daily harvest speed › Responses

Average harvest speed

average_speednumber
datestring
fruit_unitstring
total_quantitynumber
total_workersinteger

Get today's farm summary

GET

http://localhost:8000/api/v1

/farms/{farm_id}/dashboard/farm/summary

Get a summary of active workers and harvest totals for a specific farm, date, and unit

Get today's farm summary › path Parameters

farm_idstring · uuid · required
Farm ID

Get today's farm summary › query Parameters

datestring · date · required
Date
unitstring · required
Unit filter

Get today's farm summary › Responses

Today's farm summary

average_pickednumber
datestring
fruit_summariesobject[]
lowest_blockobject
most_picked_fruitobject
peak_hourobject
top_workerobject
total_active_workersinteger

Get picker efficiency metrics

GET

http://localhost:8000/api/v1

/farms/{farm_id}/dashboard/products/efficiency

Get picker efficiency metrics for all pickers on a specific farm and date, filtered by fruit type

Get picker efficiency metrics › path Parameters

farm_idstring · uuid · required
Farm ID

Get picker efficiency metrics › query Parameters

datestring · date · required
Date
fruit_idstring · uuid · required
Fruit ID

Get picker efficiency metrics › Responses

Picker efficiency metrics

datestring
detailobject[]
fruit_idstring
fruit_namestring
fruit_unitstring
fruit_varietystring
worker_codestring
worker_idstring
worker_namestring

Get product picked metrics

GET

http://localhost:8000/api/v1

/farms/{farm_id}/dashboard/products/yield

Get product picked metrics for a specific farm within a date range, optionally filtered by unit

Get product picked metrics › path Parameters

farm_idstring · uuid · required
Farm ID

Get product picked metrics › query Parameters

start_datestring · date · required
Start date
end_datestring · date · required
End date
unitstring
Unit filter

Get product picked metrics › Responses

Product picked metrics

datestring
fruitsobject[]
total_quantitynumber

Get today's worker yield

GET

http://localhost:8000/api/v1

/farms/{farm_id}/dashboard/workers/{worker_id}/yield/daily

Get yield metrics for a specific worker on a farm for a given date

Get today's worker yield › path Parameters

farm_idstring · uuid · required
Farm ID
worker_idstring · uuid · required
Worker ID

Get today's worker yield › query Parameters

datestring · date · required
Date

Get today's worker yield › Responses

Worker yield metrics

detailsobject[]
fruit_namestring
fruit_varietystring

Get weekly worker yield

GET

http://localhost:8000/api/v1

/farms/{farm_id}/dashboard/workers/{worker_id}/yield/weekly

Get yield metrics for a specific worker on a farm within a date range

Get weekly worker yield › path Parameters

farm_idstring · uuid · required
Farm ID
worker_idstring · uuid · required
Worker ID

Get weekly worker yield › query Parameters

start_datestring · date · required
Start date
end_datestring · date · required
End date

Get weekly worker yield › Responses

Worker yield metrics

detailsobject[]
fruit_namestring
fruit_varietystring

Get active pickers count

GET

http://localhost:8000/api/v1

/farms/{farm_id}/dashboard/workers/active

Get the count of active pickers for a specific farm within a date range

Get active pickers count › path Parameters

farm_idstring · uuid · required
Farm ID

Get active pickers count › query Parameters

start_datestring · date · required
Start date
end_datestring · date · required
End date

Get active pickers count › Responses

Active pickers count

datestring
totalinteger

Get worker picking efficiency

GET

http://localhost:8000/api/v1

/farms/{farm_id}/dashboard/workers/efficiency

Get picking efficiency metrics for a specific worker on a farm for a given date and fruit

Get worker picking efficiency › path Parameters

farm_idstring · uuid · required
Farm ID

Get worker picking efficiency › query Parameters

datestring · date · required
Date
worker_idstring · uuid · required
Worker ID
fruit_idstring · uuid · required
Fruit ID

Get worker picking efficiency › Responses

Worker efficiency metrics

datestring
detailobject[]
fruit_idstring
fruit_namestring
fruit_unitstring
fruit_varietystring
worker_codestring
worker_idstring
worker_namestring

Get daily worker rankings

GET

http://localhost:8000/api/v1

/farms/{farm_id}/dashboard/workers/leaderboard/daily

Get worker rankings based on harvest quantity for a specific farm and date

Get daily worker rankings › path Parameters

farm_idstring · uuid · required
Farm ID

Get daily worker rankings › query Parameters

datestring · date · required
Date
unitstring
Unit filter

Get daily worker rankings › Responses

Daily worker rankings

rankinteger
total_quantitynumber
worker_codestring
worker_idstring
worker_namestring

Get weekly worker rankings

GET

http://localhost:8000/api/v1

/farms/{farm_id}/dashboard/workers/leaderboard/weekly

Get worker rankings based on harvest quantity for a specific farm within a date range

Get weekly worker rankings › path Parameters

farm_idstring · uuid · required
Farm ID

Get weekly worker rankings › query Parameters

start_datestring · date · required
Start date
end_datestring · date · required
End date
unitstring
Unit filter

Get weekly worker rankings › Responses

Weekly worker rankings

rankinteger
total_quantitynumber
worker_codestring
worker_idstring
worker_namestring

Farm Block Fruit

Scan Harvest API

Dashboard

Endpoint:http://localhost:8000/api/v1

Get block comparison metrics

GET

http://localhost:8000/api/v1

/farms/{farm_id}/dashboard/blocks/comparison

Get block comparison metrics for specific blocks on a farm for a given date, optionally filtered by unit

Get block comparison metrics › path Parameters

farm_idstring · uuid · required
Farm ID

Get block comparison metrics › query Parameters

datestring · date · required
Date
block_idstring[] · uuid · style: form · explode: true
Block IDs
unitstring
Unit filter

Get block comparison metrics › Responses

Block comparison metrics

block_idstring
block_namestring
fruitsobject[]
total_quantitynumber

Get weekly performance metrics

GET

http://localhost:8000/api/v1

/farms/{farm_id}/dashboard/farm/performance

Get weekly performance metrics for a specific worker and fruit on a farm within a date range

Get weekly performance metrics › path Parameters

farm_idstring · uuid · required
Farm ID

Get weekly performance metrics › query Parameters

start_datestring · date · required
Start date
end_datestring · date · required
End date
worker_idstring · uuid · required
Worker ID
fruit_idstring · uuid · required
Fruit ID

Get weekly performance metrics › Responses

Weekly performance metrics

detailobject[]
end_datestring
fruit_idstring
fruit_namestring
fruit_unitstring
fruit_varietystring
start_datestring
worker_codestring
worker_idstring
worker_namestring

Get average daily harvest speed

GET

http://localhost:8000/api/v1

/farms/{farm_id}/dashboard/farm/speed

Get the average harvest speed across all workers for a specific farm on a given date

Get average daily harvest speed › path Parameters

farm_idstring · uuid · required
Farm ID

Get average daily harvest speed › query Parameters

datestring · date · required
Date
unitstring
Unit filter

Get average daily harvest speed › Responses

Average harvest speed

average_speednumber
datestring
fruit_unitstring
total_quantitynumber
total_workersinteger

Get today's farm summary

GET

http://localhost:8000/api/v1

/farms/{farm_id}/dashboard/farm/summary

Get a summary of active workers and harvest totals for a specific farm, date, and unit

Get today's farm summary › path Parameters

farm_idstring · uuid · required
Farm ID

Get today's farm summary › query Parameters

datestring · date · required
Date
unitstring · required
Unit filter

Get today's farm summary › Responses

Today's farm summary

average_pickednumber
datestring
fruit_summariesobject[]
lowest_blockobject
most_picked_fruitobject
peak_hourobject
top_workerobject
total_active_workersinteger

Get picker efficiency metrics

GET

http://localhost:8000/api/v1

/farms/{farm_id}/dashboard/products/efficiency

Get picker efficiency metrics for all pickers on a specific farm and date, filtered by fruit type

Get picker efficiency metrics › path Parameters

farm_idstring · uuid · required
Farm ID

Get picker efficiency metrics › query Parameters

datestring · date · required
Date
fruit_idstring · uuid · required
Fruit ID

Get picker efficiency metrics › Responses

Picker efficiency metrics

datestring
detailobject[]
fruit_idstring
fruit_namestring
fruit_unitstring
fruit_varietystring
worker_codestring
worker_idstring
worker_namestring

Get product picked metrics

GET

http://localhost:8000/api/v1

/farms/{farm_id}/dashboard/products/yield

Get product picked metrics for a specific farm within a date range, optionally filtered by unit

Get product picked metrics › path Parameters

farm_idstring · uuid · required
Farm ID

Get product picked metrics › query Parameters

start_datestring · date · required
Start date
end_datestring · date · required
End date
unitstring
Unit filter

Get product picked metrics › Responses

Product picked metrics

datestring
fruitsobject[]
total_quantitynumber

Get today's worker yield

GET

http://localhost:8000/api/v1

/farms/{farm_id}/dashboard/workers/{worker_id}/yield/daily

Get yield metrics for a specific worker on a farm for a given date

Get today's worker yield › path Parameters

farm_idstring · uuid · required
Farm ID
worker_idstring · uuid · required
Worker ID

Get today's worker yield › query Parameters

datestring · date · required
Date

Get today's worker yield › Responses

Worker yield metrics

detailsobject[]
fruit_namestring
fruit_varietystring

Get weekly worker yield

GET

http://localhost:8000/api/v1

/farms/{farm_id}/dashboard/workers/{worker_id}/yield/weekly

Get yield metrics for a specific worker on a farm within a date range

Get weekly worker yield › path Parameters

farm_idstring · uuid · required
Farm ID
worker_idstring · uuid · required
Worker ID

Get weekly worker yield › query Parameters

start_datestring · date · required
Start date
end_datestring · date · required
End date

Get weekly worker yield › Responses

Worker yield metrics

detailsobject[]
fruit_namestring
fruit_varietystring

Get active pickers count

GET

http://localhost:8000/api/v1

/farms/{farm_id}/dashboard/workers/active

Get the count of active pickers for a specific farm within a date range

Get active pickers count › path Parameters

farm_idstring · uuid · required
Farm ID

Get active pickers count › query Parameters

start_datestring · date · required
Start date
end_datestring · date · required
End date

Get active pickers count › Responses

Active pickers count

datestring
totalinteger

Get worker picking efficiency

GET

http://localhost:8000/api/v1

/farms/{farm_id}/dashboard/workers/efficiency

Get picking efficiency metrics for a specific worker on a farm for a given date and fruit

Get worker picking efficiency › path Parameters

farm_idstring · uuid · required
Farm ID

Get worker picking efficiency › query Parameters

datestring · date · required
Date
worker_idstring · uuid · required
Worker ID
fruit_idstring · uuid · required
Fruit ID

Get worker picking efficiency › Responses

Worker efficiency metrics

datestring
detailobject[]
fruit_idstring
fruit_namestring
fruit_unitstring
fruit_varietystring
worker_codestring
worker_idstring
worker_namestring

Get daily worker rankings

GET

http://localhost:8000/api/v1

/farms/{farm_id}/dashboard/workers/leaderboard/daily

Get worker rankings based on harvest quantity for a specific farm and date

Get daily worker rankings › path Parameters

farm_idstring · uuid · required
Farm ID

Get daily worker rankings › query Parameters

datestring · date · required
Date
unitstring
Unit filter

Get daily worker rankings › Responses

Daily worker rankings

rankinteger
total_quantitynumber
worker_codestring
worker_idstring
worker_namestring

Get weekly worker rankings

GET

http://localhost:8000/api/v1

/farms/{farm_id}/dashboard/workers/leaderboard/weekly

Get worker rankings based on harvest quantity for a specific farm within a date range

Get weekly worker rankings › path Parameters

farm_idstring · uuid · required
Farm ID

Get weekly worker rankings › query Parameters

start_datestring · date · required
Start date
end_datestring · date · required
End date
unitstring
Unit filter

Get weekly worker rankings › Responses

Weekly worker rankings

rankinteger
total_quantitynumber
worker_codestring
worker_idstring
worker_namestring

Farm Block Fruit