GET Priorities

Retrieve all priorities (indictaors where the aggregated responses are largely negative (% negative responses >= 50)) from all of an organisation's survey cycles, a particular site's survey cycles, or a specific survey cycle. If you provide no parameters, this endpoint will return all priorities across all survey cycles for your organisation, otherwise it will limit the data returned to either a specific site or a specific survey cycle depending on the parameters provided. If you provide an Id of one of your linked organisations as a parameter, the endpoint will return all priorities across all survey cycles for that organisation.

The endpoint returns an array of objects, with each object representing a survey cycle. This object includes basic information about the survey cycle, as well as a "priorities" array containing the priorities and their respective aggregate responses.

URI

https://beta.api.andwider.com/v1/reports/priorities

Headers

KEY	VALUE
AuthToken (required)	[YOUR AUTH TOKEN]
ClientId (required)	[YOUR CLIENT ID]

Parameters

KEY	VALUE
surveyCycleId (optional)	[SURVEY CYCLE ID]
siteId (optional)	[SITE ID]
organisationId (optional)	[LINKED ORGANISATION ID]

Query Parameters

KEY	DESCRIPTION
pageSize (optional)	Specifies the number of results to return per page (default is 5).
pageNumber (optional)	Specifies the page number of the results to return (default is 1)

Example Output

[
    {
        "siteName": "Org Site 1 1",
        "siteId": "e50d39f7-3f15-ec11-ae72-a085fc67909a",
        "surveyCycleName": "Site1 CC3",
        "surveyCycleId": "cbada8ca-1516-ec11-ae72-a085fc67909a",
        "completedDate": "2022-04-05T08:10:30.38",
        "priorities": [
            {
                "questionId": "6b1d950d-0986-e911-abc4-000d3ab16ad7",
                "description": "Employer helps workers with medical treatment when at work?",
                "negativePercentage": 69.57,
                "neutralPercentage": 0,
                "positivePercentage": 30.43,
                "clientTags": null
            },
            {
                "questionId": "558c852c-6195-e811-80c2-000d3ab1872b",
                "description": "Workers feel positive about work?",
                "negativePercentage": 65.22,
                "neutralPercentage": 0,
                "positivePercentage": 34.78,
                "clientTags": null
            },
            {
                "questionId": "f3b3441d-ed39-eb11-9fb4-000d3ab215fa",
                "description": "Wages paid only at the end of the season or end of the working year? ",
                "negativePercentage": 52.17,
                "neutralPercentage": 0,
                "positivePercentage": 47.83,
                "clientTags": null
            },
            {
                "questionId": "40b09190-0886-e911-abc4-000d3ab16ad7",
                "description": "Worker-only meetings allowed at work? ",
                "negativePercentage": 50,
                "neutralPercentage": 6.25,
                "positivePercentage": 43.75,
                "clientTags": null
            }
        ]
    }
]