curl 'https://www.wiseyield.co/api/v1/farms/11111111-2222-3333-4444-555555555555/health-score' \
-H "Authorization: Bearer $WISEYIELD_API_KEY"
const res = await fetch(
`https://www.wiseyield.co/api/v1/farms/${farmId}/health-score`,
{ headers: { Authorization: `Bearer ${process.env.WISEYIELD_API_KEY}` } }
);
const { data: health } = await res.json();
console.log('Overall score:', health.overallScore);
import os, requests
res = requests.get(
f'https://www.wiseyield.co/api/v1/farms/{farm_id}/health-score',
headers={'Authorization': f"Bearer {os.environ['WISEYIELD_API_KEY']}"},
)
health = res.json()['data']
{
"data": {
"overallScore": 123,
"overallLabel": "<string>",
"categories": [
{
"name": "<string>",
"score": 123,
"label": "<string>",
"signals": [
{}
]
}
],
"computedAt": "<string>"
}
}Analytics
Get farm health
Composite 0–100 farm health score plus per-category breakdowns.
GET
/
api
/
v1
/
farms
/
{id}
/
health-score
curl 'https://www.wiseyield.co/api/v1/farms/11111111-2222-3333-4444-555555555555/health-score' \
-H "Authorization: Bearer $WISEYIELD_API_KEY"
const res = await fetch(
`https://www.wiseyield.co/api/v1/farms/${farmId}/health-score`,
{ headers: { Authorization: `Bearer ${process.env.WISEYIELD_API_KEY}` } }
);
const { data: health } = await res.json();
console.log('Overall score:', health.overallScore);
import os, requests
res = requests.get(
f'https://www.wiseyield.co/api/v1/farms/{farm_id}/health-score',
headers={'Authorization': f"Bearer {os.environ['WISEYIELD_API_KEY']}"},
)
health = res.json()['data']
{
"data": {
"overallScore": 123,
"overallLabel": "<string>",
"categories": [
{
"name": "<string>",
"score": 123,
"label": "<string>",
"signals": [
{}
]
}
],
"computedAt": "<string>"
}
}GET https://www.wiseyield.co/api/v1/farms/{id}/health-score
Authentication
Requires a key with theanalytics:read scope. See Authentication.
Path parameters
string
required
Farm UUID.
Response
object
Show Farm health breakdown
Show Farm health breakdown
integer
Composite score 0–100.
string
Excellent (≥90) · Good (≥70) · Fair (≥50) · Needs Attention (<50).array
string
ISO 8601 timestamp.
curl 'https://www.wiseyield.co/api/v1/farms/11111111-2222-3333-4444-555555555555/health-score' \
-H "Authorization: Bearer $WISEYIELD_API_KEY"
const res = await fetch(
`https://www.wiseyield.co/api/v1/farms/${farmId}/health-score`,
{ headers: { Authorization: `Bearer ${process.env.WISEYIELD_API_KEY}` } }
);
const { data: health } = await res.json();
console.log('Overall score:', health.overallScore);
import os, requests
res = requests.get(
f'https://www.wiseyield.co/api/v1/farms/{farm_id}/health-score',
headers={'Authorization': f"Bearer {os.environ['WISEYIELD_API_KEY']}"},
)
health = res.json()['data']
Errors
| Status | When |
|---|---|
400 INVALID_ID | {id} is not a valid UUID |
401 | Missing, malformed, expired, or revoked API key |
403 INSUFFICIENT_SCOPE | Key lacks analytics:read scope |
404 NOT_FOUND | Farm doesn’t exist, is soft-deleted, or belongs to another user |
429 RATE_LIMIT_EXCEEDED | Per-user rate limit reached |
5xx | Server error |