live-details

📘
POST /supplier/v1/event/live-details
This method returns a list of Live and Live for testing projects, along with the status and main properties of each subsample. A subsample is open to a supplier if supplier has a valid allocation (bigger than 0) within that specific subsample, whether it is an exclusive or shared allocation.
Caching: 5 minutes

field name	description	required
eventId; eventName	Event survey number, the big umbrella under which we can have one or many different subsamples/ targets and it's name	YES
mainCategory, genericCategory,category	The category and subcategories on which the survey is conducted
mainCategory id, genericCategoryid,categoryid	Category id tree available here	YES
jobBookId,billingEntity	The entity and the number that is used when sending the invoice to suppliers
primaryProjectManager; secondaryProjectManager contactEmailAddress	The primary PM is the field coordinator and the secondary PM is the project manager assigned on survey The FC email adress
groupId
allowDesktop,Mobile,Tablet	Devices that can be used for completing the survey	YES
subsampleId; subsampleStatus; subsampleName	The cortex Survey id (subsample id), it's status and name	YES
countries, id, code, name	The country of field, It's id in our data base and also the country code	YES
locales name;liveEntryLink; testingEntryLink	Locale used for the survey and the live and testing links	YES
fieldStartDate/fieldEndDate	Field duration	YES
surveyAPIcompatibility	The flag that shows if the survey is API compatible or not ! For all API enabled surveys, SAPI=1 parameter should be appended for reporting purposes (in combination with subsample and supplier properties stored in Sample One) !	YES
requiresFlash	If flash is needed to complete the survey	YES
childSurvey	Variable that specifies if the survey is for children or not
collectPII	If the survey collects personal information.	YES
facialCoding	True when the survey uses Facial Coding technologies allowing you to target specific respondents if possible in your panel.	YES
sampleCategoryId;sampleSubCategoryId	Sample Type/ IR based
researchType/researchTypeId	Survey's research type -list available here	YES
interviewType
expectedClientLoi; expectedIncidenceRate	commissioned incidence and survey's length
targetedCurrency & CPI	currency and CPI used when sending the invoice	YES
completesAutoIncrementSchedule: -> interviews -> recurrence/ recurrenceAmount -> startTime/ endTime	A programmed increase of completes the amount of completes/total quota For how many hours/week/month is increased By when the Auto-Increment is scheduled
feasibilityId	Shows the feasibilityId if the project was pre-commissioned via Feasibility tool
automation	Shows If the study is fully automated
marketplaceEnabled	Shows if the completes allocated are through Marketplace group
needRecontact	Shows if the study needs recontact or not	YES
isSampled,IsPottential,isCricital,isMatching, isNewRecruit	These parameters should be disregarded as they have no effect on the supply API
Logic apply on this method	Check the studies with status “Live” - "subsampleStatus": "Live “ (not “live for testing”) and for those studies also check if "surveyAPIcompatibility": is “true”. To avoid the sample is not sent on studies with “0” CPI, check "targetedCPI" and if it’s higher than “0” then proceed with the checks on [Quotas] (https://ipsos-sample.readme.io/docs/quotas).

[
  {
    "eventId": 128100,
    "eventName": "SMX sample only test",
    "categories": [
      {
        "mainCategory": "Food and Beverages",
        "mainCategoryId": 1,
        "genericCategory": "FOOD-CONDIMENTS/SEASONING/SAUCES",
        "genericCategoryId": 12,
        "category": "SALAD DRESSING/SALAD OIL",
        "categoryId": 73
      }
    ],
    "jobBookId": "210025240102",
    "billingEntity": "Ipsos Interactive Services SRL",
    "primaryProjectManager": "TOMA, Dumitru",
    "secondaryProjectManager": "Coman, Mihaela",
    "contactEmailAddress": "[email protected]",
    "groupId": 0,
    "allowDesktop": true,
    "allowMobile": false,
    "allowTablet": true,
    "subsampleId": 244939,
    "subsampleStatus": "Live",
    "subsampleName": "SMX sample only test - United States - 1",
    "countries": [
      {
        "id": 221,
        "code": "US",
        "name": "United States",
        "regionName": "",
        "isPanelOneEnabled": false,
        "useP1AvailableSurveys": false
      }
    ],
    "locales": [
      {
        "name": "en-us",
        "liveEntryLink": "https://enter.ipsosinteractive.com/landing/?p=6Rj1FOuM76cMHMFghihLDWyC%2fpg%2f%2brks18JHtk%2bxY4AaSgGGwbMP9oMPnHq4uECaqslJnhMbc7bI45uicOjKV6FIXfS%2fU0OJoDLYAkFe8TE%3d&rType=31&id=",
        "testingEntryLink": "https://enter.ipsosinteractive.com/landing/?p=6Rj1FOuM76cMHMFghihLDWyC%2fpg%2f%2brks18JHtk%2bxY4AaSgGGwbMP9oMPnHq4uECaqslJnhMbc7bI45uicOjKV5%2b1IanUS8SYof%2buWPogusc%3d&rType=31&id="
      }
    ],
    "fieldStartDate": "2022-09-22T18:24:27.000",
    "fieldEndDate": "2023-03-09T09:00:00.000",
    "surveyAPIcompatibility": true,
    "requiresFlash": false,
    "childSurvey": false,
    "collectPII": false,
    "facialCoding": false,
    "sampleCategoryId": 3,
    "sampleSubCategoryId": 0,
    "researchType": "Adhoc",
    "researchTypeId": 31,
    "interviewType": 0,
    "expectedClientLoi": 15,
    "expectedIncidenceRate": 100,
    "targetedCurrency": "United States Dollar",
    "targetedCPI": 1,
    "completesAutoIncrementSchedule": null,
    "feasibilityId": null,
    "automation": false,
    "marketplaceEnabled": false,
    "needRecontact": true,
    "isSampled: true
    "isPottential":true,
    "isCritical":true,
    "isMatching":true,
    "isNewrecruit:"true
    
  }
]
  {
    "eventId": 128100,
    "eventName": "SMX sample only test",
    "categories": [
      {
        "mainCategory": "Food and Beverages",
        "mainCategoryId": 1,
        "genericCategory": "FOOD-CONDIMENTS/SEASONING/SAUCES",
        "genericCategoryId": 12,
        "category": "SALAD DRESSING/SALAD OIL",
        "categoryId": 73
      }
    ],
    "jobBookId": "210025240102",
    "billingEntity": "Ipsos Interactive Services SRL",
    "primaryProjectManager": "TOMA, Dumitru",
    "secondaryProjectManager": "Coman, Mihaela",
    "contactEmailAddress": "[email protected]",
    "groupId": 0,
    "allowDesktop": true,
    "allowMobile": false,
    "allowTablet": true,
    "subsampleId": 248566,
    "subsampleStatus": "Live",
    "subsampleName": "SMX sample only test - Romania - 2",
    "countries": [
      {
        "id": 179,
        "code": "RO",
        "name": "Romania",
        "regionName": "",
        "isPanelOneEnabled": false,
        "useP1AvailableSurveys": false
      }
    ],
    "locales": [
      {
        "name": "ro-ro",
        "liveEntryLink": "https://enter.ipsosinteractive.com/landing/?p=5ZhtiapNw%2fF%2busA0JKHnC%2bANFvSeTlHw3O2bq0bOKfofhbjcHL6QFBdrEiQu6yzhYPHVW1opaUru7LY%2fAK6KqPDPZwAcDPvSoF3MqXjBLSE%3d&rType=30&id=",
        "testingEntryLink": "https://enter.ipsosinteractive.com/landing/?p=5ZhtiapNw%2fF%2busA0JKHnC%2bANFvSeTlHw3O2bq0bOKfofhbjcHL6QFBdrEiQu6yzhYPHVW1opaUru7LY%2fAK6KqDJLWqleNL3ZellPu%2bdi02Y%3d&rType=30&id="
      }
    ],
    "fieldStartDate": "2022-12-15T16:34:27.000",
    "fieldEndDate": "2023-03-31T04:00:00.000",
    "surveyAPIcompatibility": true,
    "requiresFlash": false,
    "childSurvey": false,
    "collectPII": false,
    "facialCoding": false,
    "sampleCategoryId": 3,
    "sampleSubCategoryId": 0,
    "researchType": "Tracker",
    "researchTypeId": 30,
    "interviewType": 0,
    "expectedClientLoi": 5,
    "expectedIncidenceRate": 100,
    "targetedCurrency": "United States Dollar",
    "targetedCPI": 1,
    "completesAutoIncrementSchedule": null,
    "feasibilityId": null,
    "automation": false,
    "marketplaceEnabled": false,
    "needRecontact": false
  }
],
  {
    "eventId": 593228,
    "eventName": "SAPI Integration test study",
    "categories": [
      {
        "mainCategory": "Pet Care",
        "mainCategoryId": 450,
        "genericCategory": "Pet Care",
        "genericCategoryId": 451,
        "category": "ABOUT PETS (GENERAL)",
        "categoryId": 574
      }
    ],
    "jobBookId": "190688490102",
    "billingEntity": "IIS US - Ipsos Interactive Services U.S., Inc.",
    "primaryProjectManager": "Tipel, Anda",
    "secondaryProjectManager": "PAUL, THOMAS",
    "contactEmailAddress": "[email protected]",
    "groupId": 0,
    "allowDesktop": true,
    "allowMobile": true,
    "allowTablet": true,
    "subsampleId": 647883,
    "subsampleStatus": "Live for testing",
    "subsampleName": "SAPI Integration test study - United States - 1",
    "countries": [
      {
        "id": 221,
        "code": "US",
        "name": "United States",
        "regionName": ""
      }
    ],
    "locales": [
      {
        "name": "en-us",
        "liveEntryLink": "https://enter.ipsosinteractive.com/landing/?p=V%2fXlO%2fNXyuBS4mGdUFlTgbJNU3q0OVMXT85talpSvpmeJJ2W6lnjkumBZG%2b5J3CI%2frtLNQY%2fqbC0y8x9Bi9gcce9E9Ps50O6ogKoVWFc1cU%3d&id=",
        "testingEntryLink": "https://enter.ipsosinteractive.com/landing/?p=V%2fXlO%2fNXyuBS4mGdUFlTgbJNU3q0OVMXT85talpSvpmeJJ2W6lnjkumBZG%2b5J3CI%2frtLNQY%2fqbC0y8x9Bi9gcbVmhUUDosr7l07waXHajlU%3d&id="
      }
    ],
    "fieldStartDate": "2020-12-02T14:55:47.000",
    "fieldEndDate": "2021-03-01T20:00:00.000",
    "surveyAPIcompatibility": true,
    "requiresFlash": false,
    "childSurvey": false,
    "collectPII": false,
    "facialCoding": false,
    "sampleCategoryId": 3,
    "sampleSubCategoryId": 0,
    "researchType": "Tracker",
    "researchTypeId": 350,
    "interviewType": 0,
    "expectedClientLoi": 15,
    "expectedIncidenceRate": 80,
    "targetedCurrency": "United States Dollar",
    "targetedCPI": 0,
    "completesAutoIncrementSchedule": null,
    "feasibilityId": null,
    "automation": false,
    "marketplaceEnabled": false
  },
  {
    "eventId": 593228,
    "eventName": "SAPI Integration test study",
    "categories": [
      {
        "mainCategory": "Pet Care",
        "mainCategoryId": 450,
        "genericCategory": "Pet Care",
        "genericCategoryId": 451,
        "category": "ABOUT PETS (GENERAL)",
        "categoryId": 574
      }
    ],
    "jobBookId": "190688490102",
    "billingEntity": "IIS US - Ipsos Interactive Services U.S., Inc.",
    "primaryProjectManager": "Tipel, Anda",
    "secondaryProjectManager": "PAUL, THOMAS",
    "contactEmailAddress": "[email protected]",
    "groupId": 0,
    "allowDesktop": true,
    "allowMobile": true,
    "allowTablet": true,
    "subsampleId": 655962,
    "subsampleStatus": "Live for testing",
    "subsampleName": "SAPI Integration test study - Norway - 1",
    "countries": [
      {
        "id": 158,
        "code": "NO",
        "name": "Norway",
        "regionName": ""
      }
    ],
    "locales": [
      {
        "name": "nb-no",
        "liveEntryLink": "https://enter.ipsosinteractive.com/landing/?p=VIztCaxI9Ovcn2O37Ad8t1TiU%2fBx5ZiD6BD3x2XmYTn8jW7yF4S8F4qOw1gzUW%2bjS6780wTyGDO8VH7sMBOMZz4C1XF%2fdaFBV3jqkUe9x1M%3d&id=",
        "testingEntryLink": "https://enter.ipsosinteractive.com/landing/?p=VIztCaxI9Ovcn2O37Ad8t1TiU%2fBx5ZiD6BD3x2XmYTn8jW7yF4S8F4qOw1gzUW%2bjS6780wTyGDO8VH7sMBOMZ2Z6X7ZqK4H5HSzBUucJT7k%3d&id="
      },
      {
        "name": "nn-no",
        "liveEntryLink": "https://enter.ipsosinteractive.com/landing/?p=oL5MMEjVF%2f4YPT%2b0kXH0R55xin0h%2f4U5Sv55L5jEXHs9%2fOQV2jXzEnJ3oczTFO6D5S7ofx8x21tvMNk9%2fo3K9BtF1iAAuqfBOEvTXyG2ieA%3d&id=",
        "testingEntryLink": "https://enter.ipsosinteractive.com/landing/?p=oL5MMEjVF%2f4YPT%2b0kXH0R55xin0h%2f4U5Sv55L5jEXHs9%2fOQV2jXzEnJ3oczTFO6D5S7ofx8x21tvMNk9%2fo3K9DyL7kUNz7jCkaw6ZYUNa3s%3d&id="
      }
    ],
    "fieldStartDate": "2020-12-17T14:28:37.000",
    "fieldEndDate": "2020-12-24T22:00:00.000",
    "surveyAPIcompatibility": true,
    "requiresFlash": false,
    "childSurvey": false,
    "collectPII": false,
    "facialCoding": true,
    "sampleCategoryId": 3,
    "sampleSubCategoryId": 0,
    "researchType": "Webcruiser",
    "researchTypeId": 64,
    "interviewType": 0,
    "expectedClientLoi": 5,
    "expectedIncidenceRate": 80,
    "targetedCurrency": "United States Dollar",
    "targetedCPI": 0,
    "completesAutoIncrementSchedule": null,
    "feasibilityId": null,
    "automation": false,
    "marketplaceEnabled": false
  }
]

📘POST /supplier/v1/event/live-details

📘
POST /supplier/v1/event/live-details