post

/projects/{extProjectId}/lineItems

A line item is a project entity that exist for a specific market and language that your survey is aimed at. It defines the target panelists for the market that the survey is looking for, and the number of completes required. A line item is our unit of work and is what gets billed to you

Authorization

oauth2 - password

Request Parameters

1 Path Parameter

Request Body

1 Example
Schema
object
extLineItemId
string

A unique identifier for your Line Item

required
title
string

A Line Item title of your choosing

countryISOCode
string

2 letter ISO Country Code

2 validations + required
languageISOCode
string

2 letter ISO Language Code

2 validations + required
surveyURL
string

Survey URL to send panelist into.

surveyTestURL
string

Survey Test URL. Required for survey verification

surveyTestingNotes
string

Notes that will be shared with our Survey Auditing team

indicativeIncidence
integer

Percent of panelists you expect to qualify for the survey after they go in

2 validations + required
daysInField
integer

Number of days the survey should be active in the field. We do not stop the survey after daysInField has expired

You could either use daysInField or fieldSchedule. If both are specified, we would only apply the fieldSchedule.

2 validations
fieldSchedule
object

Fielding time of the survey expressed as start time and end time.

You could either use daysInField or fieldSchedule. If both are specified, we would only apply the fieldSchedule.

lengthOfInterview
integer

Average number of minutes it takes a user to complete your survey

2 validations + required
deliveryType
string

The plan on how responses will flow into the survey. Get the available deliveryTypes using Get StudyMetadata

1 validation
sources
array[object]

The supplier source that you would like to buy sample from. You can get the list of sources available to your account using the Get List of Sources endpoint

1 validation
targets
array[object]

Total count of survey completes required for this line item

required
quotaPlan
object

Defines the type of respondents you want to invite for the survey

Responses

1 Example
Schema
object
data
object
meta
object
status
object

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
extProjectId
$$.env
1 variable not set
oauth_access_token