API Reference
List Reports
GET /v2/report
This endpoint returns a list of the generated reports and associated metadata around the report. The endpoint is paginated and includes a collection of utility links for paginating through the responses.
Query Parameters
cursor?string
page?number
Range
1 <= value
perPage?number
Default
100
Range
1 <= value <= 1000
Header Parameters
authorization?string
The only supported authorisation method is Bearer ...
x-api-key?string
A pre-shared key provided by AgriWebb
Response Body
curl -X GET "https://api.agriwebb.com/v2/report?cursor=string&page=1&perPage=100" \
-H "authorization: string" \
-H "x-api-key: string"
{
"data": [
{
"type": "animal-load-by-paddock.v1",
"tenantType": "farm",
"tenantId": "string",
"reportingPeriodStart": 9007199254740991,
"reportingPeriodEnd": 9007199254740991,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": "pending",
"creationDate": 0,
"lastModifiedDate": 0
}
],
"meta": {
"total": 0,
"currentPage": 0,
"perPage": 0,
"totalPages": 0,
"cursor": "string"
},
"links": {
"first": "http://example.com",
"next": "http://example.com",
"prev": "http://example.com",
"last": "http://example.com",
"download": "http://example.com"
}
}
{
"error": "string"
}