Skip to main content

GET Detailed Results

Retrieve all indicators and their respective aggregate responses (% positive vs. negative vs. neutral) 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 indicators and their respective aggregate responses 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 indicators and their respective aggregate responses across all survey cycles for that organisation.

In order to accommodate easier mapping between &Wider indicators and your own, we have included an array on each indicator which can be populated with any tags you require.

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 "results" array containing the indicators and their respective aggregate responses.

URI

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

Headers

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

Parameters

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

Query Parameters

KEYDESCRIPTION
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 CC4",
"surveyCycleId": "1305ba07-1616-ec11-ae72-a085fc67909a",
"completedDate": "2022-04-06T08:10:30.38",
"results": [
{
"questionId": "6b1d950d-0986-e911-abc4-000d3ab16ad7",
"description": "Employer helps workers with medical treatment when at work?",
"negativePercentage": 46.43,
"neutralPercentage": 3.57,
"positivePercentage": 50,
"clientTags": []
},
{
"questionId": "558c852c-6195-e811-80c2-000d3ab1872b",
"description": "Workers feel positive about work?",
"negativePercentage": 42.86,
"neutralPercentage": 0,
"positivePercentage": 57.14,
"clientTags": [
"Testing"
]
},
{
"questionId": "0afb34d3-6095-e811-80c2-000d3ab1872b",
"description": "Wages ran out before month end?",
"negativePercentage": 42.86,
"neutralPercentage": 0,
"positivePercentage": 57.14,
"clientTags": []
},
{
"questionId": "f3b3441d-ed39-eb11-9fb4-000d3ab215fa",
"description": "Wages paid only at the end of the season or end of the working year? ",
"negativePercentage": 39.29,
"neutralPercentage": 0,
"positivePercentage": 60.71,
"clientTags": []
},
{
"questionId": "424e50e7-0886-e911-abc4-000d3ab16ad7",
"description": "Workers have access to drinking water?",
"negativePercentage": 35.71,
"neutralPercentage": 0,
"positivePercentage": 64.29,
"clientTags": []
},
{
"questionId": "14cb0a6c-ed39-eb11-9fb4-000d3ab215fa",
"description": "Workers been paid extra for overtime or working on weekends and public holiday? ",
"negativePercentage": 32.14,
"neutralPercentage": 7.14,
"positivePercentage": 60.71,
"clientTags": []
},
{
"questionId": "40b09190-0886-e911-abc4-000d3ab16ad7",
"description": "Worker-only meetings allowed at work? ",
"negativePercentage": 30.77,
"neutralPercentage": 5.13,
"positivePercentage": 64.1,
"clientTags": []
},
{
"questionId": "c6a0b1d2-0886-e911-abc4-000d3ab16ad7",
"description": "Workers have access to a clean toilet?",
"negativePercentage": 28.57,
"neutralPercentage": 3.57,
"positivePercentage": 67.86,
"clientTags": []
},
{
"questionId": "411815e8-6095-e811-80c2-000d3ab1872b",
"description": "Managers treat workers with respect?",
"negativePercentage": 25,
"neutralPercentage": 3.57,
"positivePercentage": 71.43,
"clientTags": []
},
{
"questionId": "57e5b215-ff65-eb11-9889-000d3ab21f35",
"description": "Workers free to leave building? ",
"negativePercentage": 21.43,
"neutralPercentage": 7.14,
"positivePercentage": 71.43,
"clientTags": []
},
{
"questionId": "fc4fb3ff-6095-e811-80c2-000d3ab1872b",
"description": "Workers have enough time to rest?",
"negativePercentage": 17.86,
"neutralPercentage": 10.71,
"positivePercentage": 71.43,
"clientTags": []
},
{
"questionId": "8e5b9c0b-ff39-eb11-9fb4-000d3ab215fa",
"description": "Workers experienced discrimination at work? ",
"negativePercentage": 17.86,
"neutralPercentage": 3.57,
"positivePercentage": 78.57,
"clientTags": []
},
{
"questionId": "6ae64aaa-4520-eb11-9fb4-000d3ab215fa",
"description": "Worker feedback encouraged?",
"negativePercentage": 17.86,
"neutralPercentage": 0,
"positivePercentage": 82.14,
"clientTags": []
},
{
"questionId": "07327fc5-0886-e911-abc4-000d3ab16ad7",
"description": "Workers have necessary protective gear?",
"negativePercentage": 14.29,
"neutralPercentage": 14.29,
"positivePercentage": 71.43,
"clientTags": []
},
{
"questionId": "6455ae1a-6195-e811-80c2-000d3ab1872b",
"description": "Workers can safely report incidents?",
"negativePercentage": 14.29,
"neutralPercentage": 3.57,
"positivePercentage": 82.14,
"clientTags": []
},
{
"questionId": "e018ec1e-f3f7-ea11-af8c-000d3ab21f86",
"description": "Workers experienced or witnessed physical punishment?",
"negativePercentage": 10.71,
"neutralPercentage": 7.14,
"positivePercentage": 82.14,
"clientTags": []
}
]
}
]