> For the complete documentation index, see [llms.txt](https://developer.prodege.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.prodege.com/surveys-feed/api-reference/survey-matching/single-survey-details.md).

# Single Survey Details

Retrieve details about a single Prodege survey.

### Get Single Survey Details

Get all available details about a Prodege survey

| Request URL    | /get-vendor-survey-data                          |
| -------------- | ------------------------------------------------ |
| Request Method | <mark style="background-color:green;">GET</mark> |

#### Request Parameters

| Parameter Name | Parameter Type | Required?                                                                       | Description                                                                            |
| -------------- | -------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| apik           | String         | Yes                                                                             | Key uniquely identifying the supplier                                                  |
| project\_id    | Numeric        | Yes                                                                             | The ID that uniquely identifies the survey. Ex: 12345                                  |
| request\_date  | Numeric        | Yes (in milliseconds)                                                           | See [authentication](/surveys-feed/api-reference/authentication/request-expiration.md) |
| signature      | String         | Yes (see [here](/surveys-feed/api-reference/authentication/request-signing.md)) | Required to authenticate supplier call                                                 |

#### Response Parameters

| Parameter Name                    | Parameter Type | Description / Notes                                                                                                                                                                                                                                                                                                                                                                                                           |
| --------------------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| return\_status                    | String         | The return status for this api call                                                                                                                                                                                                                                                                                                                                                                                           |
| surveys                           | array          | Survey details                                                                                                                                                                                                                                                                                                                                                                                                                |
| surveys array                     |                |                                                                                                                                                                                                                                                                                                                                                                                                                               |
| project\_name                     | String         | The name of the survey                                                                                                                                                                                                                                                                                                                                                                                                        |
| country\_code                     | String         | <p>The two letter country code of the country targeted by the survey. Ex: US<br><br>This will be null if the survey is targeting multiple countries. In this case, a country\_id will be defined at the quota level.</p>                                                                                                                                                                                                      |
| project\_language\_ids            | Array          | Array of languages the survey supports. If not provided, the default language for the selected country will be used. Refer to the sheet [here](https://docs.google.com/spreadsheets/d/1U53E2uj2C7S2m0fsY7mMdFk576oJf2-nDWSFI9dXUYg/edit?gid=1864678358#gid=1864678358) for a list of supported languages and each country's default.                                                                                          |
| sample\_size                      | Numeric        | The total number of responses originally available for the survey. Ex: 100                                                                                                                                                                                                                                                                                                                                                    |
| loi                               | Numeric        | Time to complete the survey (in minutes). Ex: 10                                                                                                                                                                                                                                                                                                                                                                              |
| actual\_ir                        | Numeric        | <p>The incidence rate of the survey. Ex: 85</p><p><br></p>                                                                                                                                                                                                                                                                                                                                                                    |
| conversion\_rate                  | Numeric        | The calculated conversion rate of this survey. Ex: 50.25                                                                                                                                                                                                                                                                                                                                                                      |
| cpi                               | Numeric        | Payout to supplier. Ex: 1.25                                                                                                                                                                                                                                                                                                                                                                                                  |
| projectid                         | Numeric        | The ID that uniquely identifies the survey. Ex: 12345                                                                                                                                                                                                                                                                                                                                                                         |
| surveyurl                         | String         | <p>The link survey respondents should be sent to for a given survey. Ex:  </p><p><https://www.prsrvy.com/g/survey-click?projectid=53160088&#x26;sourceid=6016&#x26;cpi=1.05&#x26;hsh=1a9c75b19eee9cdeb13f63629c69b97bad36833073eee21c00ea8ad78c4b0f2c></p>                                                                                                                                                                    |
| available                         | Boolean        | Indicates whether the survey is currently available.                                                                                                                                                                                                                                                                                                                                                                          |
| partner\_min\_days\_since\_reg    | Numeric        | The minimum number of days since a respondent was registered with Prodege before they are eligible to participate in the survey.                                                                                                                                                                                                                                                                                              |
| last\_reset\_at                   | Date/Time      | The date and time (PT) of the latest significant adjustment to the survey. Suppliers may use this value as a signal to reevaluate the survey for traffic. Returns `null` if no update has occurred.                                                                                                                                                                                                                           |
| pmr\_project\_type\_ids           | Array          | Can be used to identify recontact surveys (type ID 6) and Tracker surveys (type ID of 2).                                                                                                                                                                                                                                                                                                                                     |
| max\_clicks\_settings             | Array          | <p>Details about any click limiting that is enforced for the survey.<br><br>For example, a survey may allow only 100 total clicks from all suppliers every 30 minutes.</p>                                                                                                                                                                                                                                                    |
| max\_clicks\_settings array       |                |                                                                                                                                                                                                                                                                                                                                                                                                                               |
| max\_clicks\_cap                  | Numeric        | The total number of clicks allowed before survey traffic is paused.                                                                                                                                                                                                                                                                                                                                                           |
| max\_clicks\_max\_click\_rate\_id | Numeric        | The refill rate id for clicks (1: every 30 min, 2: every 1 hour, 3: every 24 hours, 0: one-time setting).                                                                                                                                                                                                                                                                                                                     |
| max\_clicks\_allowed\_clicks      | Numeric        | The current remaining number of clicks before survey traffic is paused.                                                                                                                                                                                                                                                                                                                                                       |
| phases                            | Array          | <p>The current phase of key survey metrics (e.g. LOI). Each metric can hold one of two potential values: <code>bid</code> or <code>actual</code>.</p><ul><li><code>bid</code>: This value indicates that the metric is based on observed activity rather an estimate.</li><li><code>actual</code>: This value signifies that a sufficient level of activity has transpired, enabling the calculation of the metric.</li></ul> |
| past\_participation               | Array          | <p>Array of inclusions/exclusions by project ID. Only participants who meet the project participation requirements will be allowed to enter the survey.<br><br>Note: If both past\_participation and limited\_panelists are present for a survey, a panelist must meet both requirements in order to eligible for the survey.</p>                                                                                             |
| past\_participation array         |                |                                                                                                                                                                                                                                                                                                                                                                                                                               |
| participation\_project\_ids       | Array          | List of project IDs that are included/excluded.                                                                                                                                                                                                                                                                                                                                                                               |
| filter\_type                      | String         | The past participation requirement. Either `exclude` or `include`.                                                                                                                                                                                                                                                                                                                                                            |
| in\_past\_days                    | Numeric        | <p>The number of days for the inclusion or exclusion. If 0, the inclusion or exclusion should apply for all time.<br><br>Example: If an exclusion was set to 1 day and it is currently Jan 2, anybody who participated on Jan 1 (any time) AND anybody who participated on the current day (any time Jan 2) would be excluded. Anybody who participated on Dec 31 would NOT be excluded.</p>                                  |
| participation\_types              | Array          | The participation type(s) that are being included or excluded. Either `click`, `complete`, `dq`, or `oq`.                                                                                                                                                                                                                                                                                                                     |
| limited\_panelists                | Array          | <p>Array of included or excluded panelists (VPIDs). If present, only included panelists are eligible to participate and excluded panelists are not eligible to participate.<br><br>Note: If both past\_participation and limited\_panelists are present for a survey, a panelist must meet both requirements in order to eligible for the survey.</p>                                                                         |
| limited\_panelists                |                |                                                                                                                                                                                                                                                                                                                                                                                                                               |
| limit\_type                       | String         | The panelist requirement. Either `exclude` or `include`.                                                                                                                                                                                                                                                                                                                                                                      |
| panelists\_ids                    | Array          | The list of included or excluded panelists (VPIDs).                                                                                                                                                                                                                                                                                                                                                                           |
| quotas                            | Array          | Array of quotas associated with the given survey.                                                                                                                                                                                                                                                                                                                                                                             |
| quotas array                      |                |                                                                                                                                                                                                                                                                                                                                                                                                                               |
| parent\_quota\_id                 | Numeric        | The parent ID that uniquely identifies the quota. See Quotas below. Ex: 123456                                                                                                                                                                                                                                                                                                                                                |
| quota\_id                         | Numeric        | The child ID that uniquely identifies the quota. See Quotas below. Ex: 123457                                                                                                                                                                                                                                                                                                                                                 |
| calculation\_type                 | Numeric        | When the quota sample size should be decremented. Possible values: 1 (Complete), 2 (Click).                                                                                                                                                                                                                                                                                                                                   |
| country\_id                       | Numeric        | <p>The <a href="https://developer.prodege.com/surveys-feed/api-reference/lookup-calls/lookup-all-supported-countries">country ID</a> being targeted by the quota.<br><br>This will only be present if the country\_code is null in the survey details since the survey is targeting multiple countries.</p>                                                                                                                   |
| sample\_size                      | Numeric        | The total number of responses originally available for the quota. Ex: 100                                                                                                                                                                                                                                                                                                                                                     |
| number\_of\_respondents           | Numeric        | The total number of allowed responses that remain from the total sample\_size. Ex: 100                                                                                                                                                                                                                                                                                                                                        |
| targeting\_criteria               | Object Array   | The respondent qualifications that describe this quota.                                                                                                                                                                                                                                                                                                                                                                       |
| targeting\_criteria array         |                |                                                                                                                                                                                                                                                                                                                                                                                                                               |
| question\_id                      | Numeric        | The ID that uniquely identifies the targeting question (see [Lookup Questions By CountryID](https://developer.prodege.com/surveys-feed/api-reference/lookup-calls/lookup-questions-by-countryid)). Ex: 3 (Gender)                                                                                                                                                                                                             |
| operator                          | String         | Possible values: OR, NOT, BETWEEN                                                                                                                                                                                                                                                                                                                                                                                             |
| precodes                          | String Array   | Array of option IDs for the associated question that are accepted for this quota (see [Lookup Questions By CountryID](https://developer.prodege.com/surveys-feed/api-reference/lookup-calls/lookup-questions-by-countryid)).                                                                                                                                                                                                  |

#### Example Response

```json
{
   "surveys":[
      {
         "quotas":[
            {
               "quota_id":293427469,
               "calculation_type":1,
               "sample_size":1116,
               "targeting_criteria":[
                  {
                     "question_id":1,
                     "operator":"BETWEEN",
                     "precodes":[
                        "18",
                        "35"
                     ]
                  },
                  {
                     "question_id":445,
                     "operator":"OR",
                     "precodes":[
                        "1",
                        "2",
                        "3",
                        "4"
                     ]
                  }
               ]
            }
         ],
         "country_code":"US",
         "surveyurl":"https://www.prsrvy.com/g/survey-click?projectid=103511581&sourceid=6016&ft=1&cpi=0.94&hsh=91938c9228c7f77f32d212300b633ba32da943cbca2ff80d55dc0ac75750eb55",
         "past_participation":{
            "participation_project_ids":[
               108994063,
               112480233,
               117931567
            ],
            "filter_type":"exclude",
            "in_past_days":7,
            "participation_types":[
               "complete",
               "dq"
            ]
         },
         "pmr_project_type_ids":[
            
         ],
         "loi":31,
         "project_language_ids":[
            "English",
            "Spanish"
         ],
         "max_clicks_settings":{
            "max_clicks_cap":1,
            "max_clicks_allowed_clicks":1,
            "max_clicks_max_click_rate_id":2
         },
         "sample_size":1116,
         "project_name":"Exciting Survey 04584",
         "projectid":103511581,
         "cpi":0.94,
         "phases":{
            "loi_phase":"bid",
            "actual_ir_phase":"bid"
         },
         "conversion_rate":19.0,
         "last_reset_at": "2026-08-10T19:12:42.000-07:00",
         "partner_min_days_since_reg":5,
         "actual_ir":44,
         "available": true,
      }
   ],
   "return_status":{
      "status_id":1,
      "message":[
         "Request Successful"
      ]
   }
}
```
