Partnership API Documentation
  1. API Integration
Partnership API Documentation
  • Introduction
  • API Integration
    • Overview
    • Flowchart
    • Authentication
    • Participant Criteria
    • Publish Study
    • Get Criteria
      GET
    • Publish Study
      POST
    • Get Study Details
      GET
    • Update Study Status
      PATCH
    • Download Report
      GET
  • iFrame Integration
    • Overview
    • Request Token
      POST
    • Get Studies
      GET
  1. API Integration

Publish Study

Developing
POST
https://poplite-service.qapopulix.co/api/v1/partnership/study

Request

Header Params

Body Params application/json

Examples

Responses

🟢200Success
application/json
Body

🟠400Validation Error
🟠401Unauthorized
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location --request POST 'https://poplite-service.qapopulix.co/api/v1/partnership/study' \
--header 'api-key: cc5e388efda46700229da6fe7b9bc38dda6ee5af' \
--header 'Content-Type: application/json' \
--data-raw '{
    "title": "Contoh Survei",
    "description": "Ini adalah survei yang mencakup semua tipe pertanyaan",
    "isScreeningQuestion": false,
    "requiredParticipants": 10,
    "questionnaire": {
        "locale": "id",
        "title": "Semua Jenis Pertanyaan Survei",
        "description": "Menguji semua jenis pertanyaan yang tersedia",
        "pages": [
            {
                "id": 1,
                "title": "",
                "description": "",
                "questions": [
                    {
                        "type": "radiogroup",
                        "name": "question1",
                        "title": "Pilih salah satu",
                        "isRequired": true,
                        "choices": [
                            {
                                "value": "Jawaban1",
                                "text": "Pilihan A"
                            },
                            {
                                "value": "Jawaban2",
                                "text": "Pilihan B"
                            }
                        ],
                        "showOtherItem": true,
                        "showNoneItem": true,
                        "noneText": "Tidak ada"
                    },
                    {
                        "type": "checkbox",
                        "name": "question2",
                        "title": "Pilih beberapa opsi",
                        "isRequired": true,
                        "choices": [
                            {
                                "value": "Jawaban1",
                                "text": "Opsi 1"
                            },
                            {
                                "value": "Jawaban2",
                                "text": "Opsi 2"
                            },
                            {
                                "value": "Jawaban3",
                                "text": "Opsi 3"
                            }
                        ],
                        "showOtherItem": true,
                        "showSelectAllItem": true,
                        "otherText": "Lainnya",
                        "selectAllText": "Pilih Semua"
                    },
                    {
                        "type": "rating",
                        "name": "question3",
                        "title": "Seberapa puas Anda?",
                        "isRequired": true,
                        "rateValues": [
                            {
                                "value": 1,
                                "text": "1"
                            },
                            {
                                "value": 2,
                                "text": "2"
                            },
                            {
                                "value": 3,
                                "text": "3"
                            },
                            {
                                "value": 4,
                                "text": "4"
                            },
                            {
                                "value": 5,
                                "text": "5"
                            }
                        ],
                        "minRateDescription": "Buruk",
                        "maxRateDescription": "Bagus"
                    },
                    {
                        "type": "imagepicker",
                        "name": "question4",
                        "title": "Pilih gambar favorit Anda",
                        "isRequired": true,
                        "choices": [
                            {
                                "value": "Jawaban1",
                                "imageLink": "https://example.com/image1.png",
                                "text": "Gambar 1"
                            },
                            {
                                "value": "Jawaban2",
                                "imageLink": "https://example.com/image2.png",
                                "text": "Gambar 2"
                            }
                        ],
                        "showLabel": true
                    },
                    {
                        "type": "text",
                        "name": "question5",
                        "title": "Tuliskan nama Anda",
                        "isRequired": true
                    },
                    {
                        "type": "comment",
                        "name": "question6",
                        "title": "Berikan komentar Anda",
                        "isRequired": true
                    },
                    {
                        "type": "matrix",
                        "name": "question7",
                        "title": "Nilai fitur berikut",
                        "isRequired": true,
                        "columns": [
                            {
                                "value": "Column 1",
                                "text": "Baik"
                            },
                            {
                                "value": "Column 2",
                                "text": "Biasa"
                            },
                            {
                                "value": "Column 3",
                                "text": "Buruk"
                            }
                        ],
                        "rows": [
                            {
                                "value": "Row 1",
                                "text": "Fitur 1"
                            },
                            {
                                "value": "Row 2",
                                "text": "Fitur 2"
                            }
                        ],
                        "eachRowRequired": true
                    },
                    {
                        "type": "matrixdropdown",
                        "name": "question8",
                        "title": "Pilih opsi untuk tiap kategori",
                        "isRequired": true,
                        "columns": [
                            {
                                "name": "opsi",
                                "title": "Opsi",
                                "cellType": "dropdown",
                                "isRequired": true,
                                "choices": [
                                    {
                                        "value": "Column 1",
                                        "text": "Ya"
                                    },
                                    {
                                        "value": "Column 2",
                                        "text": "Tidak"
                                    }
                                ]
                            }
                        ],
                        "rows": [
                            {
                                "value": "Row 1",
                                "text": "Kategori 1"
                            },
                            {
                                "value": "Row 2",
                                "text": "Kategori 2"
                            }
                        ]
                    },
                    {
                        "type": "multipletext",
                        "name": "question9",
                        "title": "Masukkan informasi kontak Anda",
                        "isRequired": true,
                        "items": [
                            {
                                "name": "text1",
                                "title": "Email"
                            },
                            {
                                "name": "text2",
                                "title": "No. HP"
                            }
                        ]
                    },
                    {
                        "type": "image",
                        "name": "question10",
                        "title": "Logo Populix",
                        "imageLink": "https://example.com/logo.png",
                        "contentMode": "image",
                        "imageHeight": "300px",
                        "imageWidth": "100%"
                    },
                    {
                        "type": "ranking",
                        "name": "question11",
                        "title": "Urutkan preferensi Anda",
                        "isRequired": true,
                        "choices": [
                            {
                                "value": "Jawaban1",
                                "text": "Item A"
                            },
                            {
                                "value": "Jawaban2",
                                "text": "Item B"
                            },
                            {
                                "value": "Jawaban3",
                                "text": "Item C"
                            }
                        ]
                    }
                ]
            }
        ]
    },
    "criteria": {
        "Gender": [
            "Laki-Laki",
            "Perempuan"
        ],
        "Age": [
            18,
            35
        ],
        "SocialEconomicStatusGroup": [
            "Upper",
            "Middle",
            "Lower"
        ]
    }
}'
Response Response Example
200 - Success
{
    "traceId": "d8f4e8a5-4a04-4cab-bad4-71b8fac08448",
    "result": {
        "code": "SUCCESS",
        "message": "Success",
        "data": {
            "id": "67890",
            "title": "My Study",
            "status": "IN_PROGRESS"
        }
    }
}
Modified at 2025-06-04 07:14:15
Previous
Get Criteria
Next
Get Study Details
Built with