Add Target to group

Request

Path Params

GroupId

number

required

Header Params

x-access-token

string

required

YOUR_X-ACCESS-TOKEN_HERE

Content-Type

string

required

application/json

Body Params application/json

Options

array[number]

required

For AGE and ZipCodes, Array of String. e.g.: AGE - [“18-25”, “45-60”] and ZIPCODES - [“23213”, “34543”]. For all other targets it will be array of numbers(OptionIds of Question Module) e.g.: [1, 3, 4]

QuestionId

number

required

Question Id as in Questions Library

Example

{
    "Options": [
        "13-34",
        "45-66"
    ],
    "QuestionId": 1
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://apivisionsampling.innovatemr.com/api/v2/pega/group//target' \
--header 'x-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Options": [
        "13-34",
        "45-66"
    ],
    "QuestionId": 1
}'

Responses

🟢200Success

application/json

Body

apiStatus

string

required

msg

string

required

Target

array [object {8}]

required

Type

string

optional

Sequence

integer

optional

QuestionId

integer

optional

QuestionKey

string

optional

QuestionType

string

optional

QuestionText

string

optional

Category

integer

optional

Options

array [object {3}]

optional

group

object

required

Target

object

required

Status

integer

required

Name

string

required

N

integer

required

IncidenceRate

integer

required

CostPerInterview

integer

required

EstCostPerInterview

integer

required

LengthOfInterview

integer

required

LiveSurveyUrl

string

required

JobId

integer

required

CompanyId

integer

required

DeviceType

integer

required

CountryCode

string

required

Language

string

required

Id

integer

required

CreatedDate

string

required

SID

string

required

Fielding

object

required

Example

{
    "apiStatus": "success",
    "msg": "Target updated successfully",
    "Target": [
        {
            "Type": "",
            "Sequence": 1,
            "QuestionId": 1,
            "QuestionKey": "AGE",
            "QuestionType": "Numeric Open Ended",
            "QuestionText": "What is your age?",
            "Category": 1,
            "Options": [
                {
                    "OptionId": 1,
                    "AgeStart": "13",
                    "AgeEnd": "34"
                },
                {
                    "OptionId": 2,
                    "AgeStart": "45",
                    "AgeEnd": "66"
                }
            ]
        }
    ]
}