Skip to main content
POST
/
surveys
/
one
/
{surveyNumber}
Get Single Survey
curl --request POST \
  --url https://api.publisher.miratsquanto.com/api/v1/publisher/surveys/one/{surveyNumber} \
  --header 'Content-Type: application/json' \
  --header 'publisher-authentication-key: <api-key>' \
  --data '
{
  "authorizationKey": "DqcInvhIFAl5WtUNwihFUIgUH77EL2hTNRU"
}
'
{
  "length_of_interview": "10",
  "incidence_rate": "10",
  "surveyNumber": 17633744316852264,
  "loi": 10,
  "ir": 10,
  "survey_created_date": "2025-11-17T10:24:10.829Z",
  "survey_last_updated_date": "2025-11-17T10:24:10.829Z",
  "qualification": [
    {
      "question": "AGE",
      "validOptions": [
        {
          "from": 18,
          "to": 55
        }
      ],
      "displayOptions": [
        "Male"
      ],
      "quotas": {
        "Male": 0,
        "Female": 13
      },
      "questionType": "Single Punch",
      "preCodes": [
        "18"
      ]
    }
  ],
  "projectName": "New Campaign 007",
  "projectNumber": 10000092,
  "organisation": "Mirats Quanto"
}

​
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

POST /surveys/one/{surveyNumber}

​
Headers

{
  "publisher-authentication-key": "your_project_secret_key"
}
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

{
  "authorizationKey": "DqcInvhIFAl5WtUNwihFUIgUH77EL2hTNRU"
}

​
Response

{
  "length_of_interview": "10",
  "incidence_rate": "10",
  "survey_created_date": "2025-11-17T10:24:10.829Z",
  "survey_last_updated_date": "2025-11-17T10:24:10.829Z",
  "surveyNumber": 17633744316852264,
  "qualification": [
    {
      "question": "AGE",
      "validOptions": [
        {
          "from": 18,
          "to": 55
        }
      ],
      "displayOptions": [],
      "quotas": {}
    },
    {
      "question": "GENDER",
      "validOptions": [
        "Male",
        "Female"
      ],
      "displayOptions": [
        "Male",
        "Female"
      ],
      "quotas": {
        "Male": 0,
        "Female": 13
      }
    },
    {
      "question": "STANDARD_HHI_US",
      "validOptions": [
        "$100,000 to $124,999",
        "$125,000 to $149,999",
        "$150,000 to $174,999",
        "$175,000 to $199,999",
        "$200,000 to $249,999",
        "$250,000 and above"
      ],
      "displayOptions": [
        "Less than $5,000",
        "$5,000 to $9,999",
        "$10,000 to $14,999",
        "$15,000 to $19,999",
        "$20,000 to $24,999",
        "$25,000 to $29,999",
        "$30,000 to $34,999",
        "$35,000 to $39,999",
        "$40,000 to $44,999",
        "$45,000 to $49,999",
        "$50,000 to $54,999",
        "$55,000 to $59,999",
        "$60,000 to $64,999",
        "$65,000 to $69,999",
        "$70,000 to $74,999",
        "$75,000 to $79,999",
        "$80,000 to $84,999",
        "$85,000 to $89,999",
        "$90,000 to $94,999",
        "$95,000 to $99,999",
        "$100,000 to $124,999",
        "$125,000 to $149,999",
        "$150,000 to $174,999",
        "$175,000 to $199,999",
        "$200,000 to $249,999",
        "$250,000 and above",
        "Prefer not to answer"
      ],
      "quotas": {}
    }
  ],
  "projectName": "New Campaign 007",
  "projectNumber": 10000092,
  "organisation": "Mirats Quanto"
}

​
Error Response

{
  "message": "internal server error",
  "code": 500,
  "success": false
}

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"