event-all
complete list of events
POST /supplier/v1/event/all
Returns a list of all subsamples including main subsample and event properties where supplier had or has a valid allocation no matter the survey status.
Optional, the list can be filtered by date (date when projects were created, date format is yyyy-MM-dd UTC) or by subsample status (by specifying the status code).
Caching: 5 minutes
field name | description | type | required |
---|---|---|---|
eventId | Event survey number, the big umbrella under which we can have one or many different subsamples/ targets | ||
billingEntity | The entity that is used when sending the invoice to suppliers | ||
subsampleId | subsample identification number-> cortex id | ||
subsampleStatus: "Complete", "Pending","Live for testing" and "Live" | The subsample status on IIS side when running the method | ||
subsampleName | Subsample name on IIS side | ||
country, id, code, name, region Name | the country's name, id on our data base and it's code of the subsample on which they were added in the blend | ||
fieldStartDate/fieldEndDate | the subsample's field duration |
Status id | Status name |
---|---|
1 | Pending (A subsample initially holds this status upon creation and remains so until the necessary adjustments are executed by Ipsos Project Managers. This status may reoccur if further modifications are required from the Ipsos side). |
3 | Live (A subsample with this status is prepared to receive traffic. This is the sole status in which real respondents should access the subsample). |
4 | Complete (When a subsample is marked with this status, it indicates that it no longer requires additional traffic and is officially closed). |
5 | Canceled (A subsample is assigned this status if it has been determined that it will not be utilized). |
6 | Live for testing (A subsample is assigned this status during the testing phase). |
[
{
"eventId": 101580,
"billingEntity": "",
"subsampleId": 101694,
"subsampleStatus": "Pending",
"subsampleName": "Fizzy testing - United States - 1",
"country": {
"id": 221,
"code": "US",
"name": "United States",
"regionName": ""
},
"fieldStartDate": "2019-02-18T05:00:00.000",
"fieldEndDate": "2019-02-25T05:00:00.000"
},
{
"eventId": 101580,
"billingEntity": "",
"subsampleId": 101696,
"subsampleStatus": "Pending",
"subsampleName": "Fizzy testing - United States - 2",
"country": {
"id": 221,
"code": "US",
"name": "United States",
"regionName": ""
},
"fieldStartDate": "2019-02-13T05:00:00.000",
"fieldEndDate": "2019-02-19T05:00:00.000"
},
{
"eventId": 101416,
"billingEntity": "",
"subsampleId": 101698,
"subsampleStatus": "Pending",
"subsampleName": "CA - OLU: Canada EDM1 Test - Bog W1 - United States - 1",
"country": {
"id": 221,
"code": "US",
"name": "United States",
"regionName": ""
},
"fieldStartDate": "2019-02-14T08:00:00.000",
"fieldEndDate": "2019-02-16T08:00:00.000"
},
{
"eventId": 101580,
"billingEntity": "",
"subsampleId": 101704,
"subsampleStatus": "Pending",
"subsampleName": "Fizzy testing - United States - 3",
"country": {
"id": 221,
"code": "US",
"name": "United States",
"regionName": ""
},
"fieldStartDate": "2019-02-22T08:00:00.000",
"fieldEndDate": "2019-02-28T08:00:00.000"
},
{
"eventId": 101581,
"billingEntity": "IIS EU",
"subsampleId": 101706,
"subsampleStatus": "Pending",
"subsampleName": "RE: Ipsos SupplyAPI for trackers - Canada - 1",
"country": {
"id": 36,
"code": "CA",
"name": "Canada",
"regionName": ""
},
"fieldStartDate": "2019-02-25T12:00:00.000",
"fieldEndDate": "2019-03-07T08:00:00.000"
},
{
"eventId": 101580,
"billingEntity": "",
"subsampleId": 101709,
"subsampleStatus": "Pending",
"subsampleName": "Fizzy testing - United States - 4",
"country": {
"id": 221,
"code": "US",
"name": "United States",
"regionName": ""
},
"fieldStartDate": "2019-03-05T08:00:00.000",
"fieldEndDate": "2019-03-26T07:00:00.000"
},
{
"eventId": 101580,
"billingEntity": "",
"subsampleId": 101710,
"subsampleStatus": "Pending",
"subsampleName": "Fizzy testing - United States - 5",
"country": {
"id": 221,
"code": "US",
"name": "United States",
"regionName": ""
},
"fieldStartDate": "2019-03-05T08:00:00.000",
"fieldEndDate": "2019-03-26T07:00:00.000"
},
{
"eventId": 101580,
"billingEntity": "",
"subsampleId": 101711,
"subsampleStatus": "Pending",
"subsampleName": "Fizzy testing - United States - 6",
"country": {
"id": 221,
"code": "US",
"name": "United States",
"regionName": ""
},
"fieldStartDate": "2019-03-05T08:00:00.000",
"fieldEndDate": "2019-03-30T07:00:00.000"
}
]
Updated about 2 months ago