Skip to main content
POST
Get Single Survey

Get Single Survey

Retrieve details of a specific survey by its survey number.
Note: The fields loi and ir are going to be deprecated soon. Please use length_of_interview and incidence_rate instead.

Endpoint

Headers

Note: The publisher-authentication-key header corresponds to your Secret Key. The authorizationKey in the request body corresponds to your Web API Key.

Request Body

Response

Error Response

Authorizations

publisher-authentication-key
string
header
required

Send your Secret Key using the publisher-authentication-key header. This header is required for every request.

Path Parameters

surveyNumber
integer
required
Example:

17633744316852264

Body

application/json

Payload for endpoints that only require the Web API Key in the request body.

authorizationKey
string
required

Web API Key obtained from the Mirats Publisher Platform.

Example:

"DqcInvhIFAl5WtUNwihFUIgUH77EL2hTNRU"

Response

Successful response with survey details

length_of_interview
string
required

Length of interview in minutes

Example:

"10"

incidence_rate
string
required

Incidence rate as a percentage

Example:

"10"

surveyNumber
integer
required
Example:

17633744316852264

loi
integer
deprecated

Deprecating Soon: Use 'length_of_interview' instead. This field will be removed in a future version.

Example:

10

ir
integer
deprecated

Deprecating Soon: Use 'incidence_rate' instead. This field will be removed in a future version.

Example:

10

survey_created_date
string<date-time>
Example:

"2025-11-17T10:24:10.829Z"

survey_last_updated_date
string<date-time>
Example:

"2025-11-17T10:24:10.829Z"

qualification
object[]
projectName
string
Example:

"New Campaign 007"

projectNumber
integer
Example:

10000092

organisation
string
Example:

"Mirats Quanto"