milking-sessions Endpoint

Returns milking parlor visit data for all milking animals in the herd. Only live animals are included in the response for this endpoint. For additional data on daily milk, see daily-milking-averages Endpoint.

IMPORTANT:

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

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}/milking-sessions \
-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

Includes data from the most recent milking session.

Date/time stamp (YYYY-MM-DDThh:mm:ss in 24-hour UTCClosed Coordinated Universal Time, also known as Greenwich Mean Time (GMT) time) of the start of the animal's most recent milking if the dairy has the VAS ParlorBoss product installed and shifts configured in PULSE. See the Important note above for additional details.

Date of the start of the herd's most recent milking. If the herd starts a shift before midnight, this date may be the day before the actual date the animal was milked.

Time of the animal's most recent milking

Milking shift number. Parlor shifts must be configured in PULSE with start and end times. See the Important note above for additional details.

Parlor stall number

Duration of the most recent milking session

Units for milking time: 

MIN: value is provided in minutes

Number of minutes for the milking session

Pen assigned at the most recent milking session

Milk weight from the most recent milking session

Units for milk weight value: 

KGM: kilograms

Volume of milk (in kilograms)

Includes data from previous milking sessions completed in the last 24 hours.

Milk weight from the most recent milking session

Units for milk weight value: 

KGM: kilograms

Volume of milk (in kilograms)

Milking shift

Date/time stamp (YYYY-MM-DDThh:mm:ss in 24-hour UTC time) of the milking.

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"
            },
            "mostRecentMilkingSession": {                
                "milkingStartingDateTime": "2025-05-15T00:01:00.000Z",
                "milkingStartingDate": "2025-05-14T04:00:00+00:00",
                "milkingStartingTime": "00:01",
                "milkingShiftNumber": 2,
                "milkingBoxNumber": "45",
                "milkingDuration": {
                    "unitCode": "MIN",
                    "value": 4
                },
                "milkingPen": 2,
                "milkingMilkWeight": {
                    "unitCode": "KGM",
                    "value": 19.051
                }
            },
            "previousMilkingSessions": [
                {
                    "milkingMilkWeight": {
                        "unitCode": "KGM",
                        "value": 9.752
                    },
                    "milkingShiftNumber": 1,
                    "milkDate": "2024-10-27T15:35:00+00:00"
                },
                {
                    "milkingMilkWeight": {
                        "unitCode": "KGM",
                        "value": 17.917
                    },
                    "milkingShiftNumber": 1,
                    "milkDate": "2024-10-26T15:35:00+00:00"
                },
                {
                    "milkingMilkWeight": {
                        "unitCode": "KGM",
                        "value": 14.288
                    },
                    "milkingShiftNumber": 2,
                    "milkDate": "2024-10-26T15:35:00+00:00"
                },
                {
                    "milkingMilkWeight": {
                        "unitCode": "KGM",
                        "value": 16.783
                    },
                    "milkingShiftNumber": 3,
                    "milkDate": "2024-10-26T15:35:00+00:00"
                }
            ]
        }
    ]
}
NOTE: See API Errors and HTTP Status Code Details for a list of API errors and HTTP status codes.
< Return to Milk Resource