GET Response Rates

Retrieve the response rates, from all of an organisation's survey cycles, a particular site's survey cycles, or a specific survey cycle.

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 the number and percentage of respondents who either completed the survey, submitted an incomplete survey, opted out of the survey or were unreachable.

URI

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

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",
        "total": 91,
        "unreachable": 66,
        "optedOut": 2,
        "incomplete": 0,
        "complete": 23,
        "unreachablePercentage": 72.5,
        "optedOutPercentage": 2.2,
        "incompletePercentage": 0,
        "completePercentage": 25.3
    }
]