daily-milking-averages Endpoint

Returns average daily milking data for all milking animals in the herd. Only live animals are included in the response for this endpoint. For additional data on milk weights collected for animals in the herd, see milking-sessions Endpoint.

GET https://integrations.prod.vas.com/api/locations/com.vas.dairies.id/{location-id}/daily-milking-averages

Path Parameters (required)

The following parameters must be included in the request path for this endpoint: 

{location-id}integerREQUIRED

VAS-specificClosed A data value that originates from the VAS product line. [dairy] location identifier. For routes with “com.vas.dairies.id”, {location-id} is a VAS-specific dairy id.

This endpoint supports the following query parameters, which can be used to control or limit the results returned:

pageinteger

Sets the page number to display in the results.

  • page=3 sets the third page to display.

If no parameter is defined, page 1 displays.

pageSizeinteger

Sets the number of items to display on each page of results.

  • pageSize=50 sets the page to include 50 items per page.

If no parameter is defined, the response includes 10 items per page. The maximum pageSize is 1000.

Sample Request (cURL) 
curl -X GET \
https://integrations.prod.vas.com/api/locations/com.vas.dairies.id/{location-id}/daily-milking-averages \
-H 'Authorization: bearer {authorization token}' \
-H 'X-API-Key: {API key}'

Response Schema

The animal data includes animal identification details.

idinteger

VAS-specific dairy cow identifier. This number is used in all VAS products, including PULSE and DairyComp 305. This identifier is unique to each animal in the VAS suite of products, and is the most stable and reliable source of animal identification data. dairyCowId differs from the animal's cowNumber, displayCowNumber, EIDClosed 15-digit electronic ID number associated with the animal eartag, and isoId.

schemestring

Identifies the data source as VAS: com.vas.animals.id

The location data specifies the animal's dairyId information.

VAS-specific dairy identifier

Identifies the data source as VAS: com.vas.dairies.id

The pen data specifies the animal's pen information.

id integer

VAS-specific pen identifier

schemestring

Identifies the data source as VAS: com.vas.pens.id

idinteger

Pen number at the time of the event

schemestring

Identifies the data source as VAS: com.vas.pens.number

Animal's lactation number

Includes milk amount data from the previous day.

Units for milk weight value: 

LBR: pounds (lbs)

Average volume of milk produced during the last day

Includes milk amount data from the previous week.

Units for milk weight value: 

LBR: pounds (lbs)

Average volume of milk produced during the last 7 days

Last milking date included in the milking average values

Expected daily milk weight (in lbs)

Deviation from the expected daily milk weight (in lbs)

Deviation from the expected weekly milk weight (in lbs)

Deviation from the expected milk weight that is calculated using the ARIMA model (autoregressive integrated moving average, in lbs)

Estimated week 4 milk weight, which is calculated using the weekly milk weight data (in lbs)

Estimated week 8 milk weight, which is calculated using the weekly milk weight data (in lbs)

Estimated week 12 milk weight, which is calculated using the weekly milk weight data (in lbs)

Estimated week 16 milk weight, which is calculated using the weekly milk weight data (in lbs)

Estimated week 20 milk weight, which is calculated using the weekly milk weight data (in lbs)

Estimated week 24 milk weight, which is calculated using the weekly milk weight data (in lbs)

Sample Response (JSON) 
{
    "view": {
        "pageSize": 10,
        "currentPage": 1,
        "totalPages": 1,
        "totalItems": 1
    },    
     "member": [
        {
            "animal": {
                "identifier": {
                    "id": "103264358",
                    "scheme": "com.vas.animals.id"
                }
            },
            "location": {
                "id": "679",
                "scheme": "com.vas.dairies.id"
            },
            "pen": {
                "identifier": {
                    "id": "103264358",
                    "scheme": "com.vas.pens.id"
                },
                "alternativeIdentifiers": [
                    {
                        "id": "1",
                        "scheme": "com.vas.pens.number"
                    }
                ]
            },
            "lactation": 2,
            "milkYieldAvg24h": {
                "unitCode": "LBR",
                "value": null
            },
            "milkYieldAvg7days": {
                "unitCode": "LBR",
                "value": null
            },
            "averageDate": "2024-10-27T15:35:00+00:00",
            "expectedDailyMilk": null,
            "deviationFromExpectedMilk": null,
            "weeklyMilkDeviation": null,
            "dmArimaDeviationFromExpected": null,
            "week4EstimatedMilk": 103,
            "week8EstimatedMilk": 112,
            "week12EstimatedMilk": 108,
            "week16EstimatedMilk": null,
            "week20EstimatedMilk": null,
            "week24EstimatedMilk": null
        }
    ]
}
NOTE: See API Errors and HTTP Status Code Details for a list of API errors and HTTP status codes.
< Return to Milk Resource