Position Green API: Measures

Modified on Thu, 10 Apr at 8:13 AM

Measures in Position Green define the entire body of data you want to collect during a reporting year, this includes who will report the data, how often, and what organizational units. The measure is created by the Controller in Setup using Measure Builder.

To test the below endpoint please go to our Swagger UI page.

Properties of a Measure object

Property	Data Type	Description
id	Guid	Id of the measure
name	string	Name of the measure
aspectName	string	The aspect it belongs to
prettyId	string	Pretty ID of the measures

Get all measures

GET https://api.positiongreen.com/v1/measures

Returns all measures

Query Parameters

Name	Type	Description
yearId	string	Id of the year
nameFilter	string	Filters by measure name, using 'nameFilter'
first	string	Limits the result set. Default 10. Minimum 1 and maximum 500.
after	integer	Cursor that points to where to continue the result set.
sortBy	string	'Name'
sortDirection	string	'Ascending' or 'Descending'. Default 'Ascending'.

{
    "totalCount": 70,
    "pageInfo": {
        "hasNextPage": true,
        "startCursor": "aWR4OzA=",
        "endCursor": "aWR4Ozk="
    },
    "items": [
        {
            "cursor": "aWR4OzA=",
            "node": {
                "id": "da8e4c7d-5ffb-418b-ad3c-35c6be177fe7",
                "name": "Actual working hours",
                "aspectName": "OH&S"
            }
        }
    ]
}

Example: getting the first 2 measures containing '201' in the name using curl

curl --request GET --header 'Authorization: Bearer <access token>'
'<api url>/measures?yearId=<year id>&first=2&nameFilter=201'