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

Get Study Details

Developing
GET
https://poplite-service.qapopulix.co/api/v1/partnership/study/{id}

Request

Path Params

Header Params

Responses

🟢200Success
application/json
Body

🟠401Unauthorized
🟠404Not Found
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://poplite-service.qapopulix.co/api/v1/partnership/study/75703' \
--header 'api-key: cc5e388efda46700229da6fe7b9bc38dda6ee5af'
Response Response Example
200 - Success
{
    "traceId": "d8f4e8a5-4a04-4cab-bad4-71b8fac08448",
    "result": {
        "code": "SUCCESS",
        "message": "Success",
        "data": {
            "id": 75703,
            "title": "Kebiasaan Konsumsi makanan manis dan hubungannya dengan mood yang baik",
            "description": "Ingin mengetahui snack merek apa yang sering dikonsumsi, kapan terpikir untuk mengkonsumsi snack tersebut, apakah suka menyimpan stok snack tersebut, beli di mana, dan keputusan beli di siapa.",
            "requiredParticipants": 5,
            "status": "IN_PROGRESS",
            "criteria": {
                "Age": [
                    18,
                    35
                ],
                "Gender": [
                    "Laki-Laki",
                    "Perempuan"
                ],
                "SocialEconomicStatusV2": [
                    "Upper 1",
                    "Upper 2",
                    "Middle 1",
                    "Middle 2",
                    "Lower 1",
                    "Lower 2"
                ],
                "SocialEconomicStatusGroup": [
                    "Upper",
                    "Middle",
                    "Lower"
                ]
            },
            "isScreeningQuestion": false,
            "approvedParticipant": 1,
            "questionnaire": {
                "pages": [
                    {
                        "id": 1,
                        "title": "",
                        "enableIf": null,
                        "questions": [
                            {
                                "name": "question1",
                                "type": "radiogroup",
                                "title": "Seberapa sering Anda mengonsumsi snack dalam sehari?",
                                "choices": [
                                    {
                                        "text": "1-2 kali",
                                        "value": "Jawaban1"
                                    },
                                    {
                                        "text": "3-4 kali",
                                        "value": "Jawaban2"
                                    },
                                    {
                                        "text": "Lebih dari 4 kali",
                                        "value": "Jawaban3"
                                    }
                                ],
                                "isRequired": true,
                                "populixType": "additionalQuestion"
                            },
                            {
                                "name": "question2",
                                "type": "checkbox",
                                "title": "Kapan biasanya Anda merasa ingin mengonsumsi snack?",
                                "choices": [
                                    {
                                        "text": "Pagi hari",
                                        "value": "Jawaban1"
                                    },
                                    {
                                        "text": "Siang hari",
                                        "value": "Jawaban2"
                                    },
                                    {
                                        "text": "Sore hari",
                                        "value": "Jawaban3"
                                    },
                                    {
                                        "text": "Malam hari",
                                        "value": "Jawaban4"
                                    }
                                ],
                                "isRequired": true,
                                "populixType": "additionalQuestion"
                            },
                            {
                                "name": "question3",
                                "type": "text",
                                "title": "Sebutkan 3 merek snack yang paling sering Anda konsumsi!",
                                "isRequired": true,
                                "populixType": "additionalQuestion"
                            },
                            {
                                "name": "question4",
                                "type": "radiogroup",
                                "title": "Apakah Anda biasanya memiliki stok snack di rumah?",
                                "choices": [
                                    {
                                        "text": "Ya",
                                        "value": "Jawaban1"
                                    },
                                    {
                                        "text": "Tidak",
                                        "value": "Jawaban2"
                                    }
                                ],
                                "isRequired": true,
                                "populixType": "additionalQuestion"
                            },
                            {
                                "name": "question5",
                                "type": "text",
                                "title": "Jika ya, snack apa saja yang biasanya Anda stok?",
                                "isRequired": true,
                                "populixType": "additionalQuestion"
                            },
                            {
                                "name": "question6",
                                "type": "checkbox",
                                "title": "Di mana Anda biasanya membeli snack?",
                                "choices": [
                                    {
                                        "text": "Supermarket",
                                        "value": "Jawaban1"
                                    },
                                    {
                                        "text": "Minimarket",
                                        "value": "Jawaban2"
                                    },
                                    {
                                        "text": "Toko online",
                                        "value": "Jawaban3"
                                    },
                                    {
                                        "text": "Warung",
                                        "value": "Jawaban4"
                                    },
                                    {
                                        "text": "Lainnya",
                                        "value": "Jawaban5"
                                    }
                                ],
                                "isRequired": true,
                                "populixType": "additionalQuestion"
                            },
                            {
                                "name": "question7",
                                "type": "checkbox",
                                "title": "Faktor apa yang paling mempengaruhi keputusan Anda dalam membeli snack?",
                                "choices": [
                                    {
                                        "text": "Harga",
                                        "value": "Jawaban1"
                                    },
                                    {
                                        "text": "Rasa",
                                        "value": "Jawaban2"
                                    },
                                    {
                                        "text": "Brand/Merek",
                                        "value": "Jawaban3"
                                    },
                                    {
                                        "text": "Promosi",
                                        "value": "Jawaban4"
                                    },
                                    {
                                        "text": "Ketersediaan",
                                        "value": "Jawaban5"
                                    },
                                    {
                                        "text": "Lainnya",
                                        "value": "Jawaban6"
                                    }
                                ],
                                "isRequired": true,
                                "populixType": "additionalQuestion"
                            },
                            {
                                "name": "question8",
                                "type": "rating",
                                "title": "Seberapa mudah Anda tergiur untuk membeli snack saat melihat iklan atau promosi?",
                                "isRequired": true,
                                "rateValues": [
                                    {
                                        "text": "1",
                                        "value": "1"
                                    },
                                    {
                                        "text": "2",
                                        "value": "2"
                                    },
                                    {
                                        "text": "3",
                                        "value": "3"
                                    },
                                    {
                                        "text": "4",
                                        "value": "4"
                                    },
                                    {
                                        "text": "5",
                                        "value": "5"
                                    }
                                ],
                                "populixType": "additionalQuestion"
                            },
                            {
                                "name": "question9",
                                "type": "radiogroup",
                                "title": "Apakah Anda sering mencoba snack merek baru?",
                                "choices": [
                                    {
                                        "text": "Ya",
                                        "value": "Jawaban1"
                                    },
                                    {
                                        "text": "Tidak",
                                        "value": "Jawaban2"
                                    }
                                ],
                                "isRequired": true,
                                "populixType": "additionalQuestion"
                            },
                            {
                                "name": "question10",
                                "type": "checkbox",
                                "title": "Apa yang biasanya memotivasi Anda untuk mencoba snack merek baru?",
                                "choices": [
                                    {
                                        "text": "Rekomendasi teman/keluarga",
                                        "value": "Jawaban1"
                                    },
                                    {
                                        "text": "Iklan",
                                        "value": "Jawaban2"
                                    },
                                    {
                                        "text": "Promosi",
                                        "value": "Jawaban3"
                                    },
                                    {
                                        "text": "Penasaran",
                                        "value": "Jawaban4"
                                    },
                                    {
                                        "text": "Lainnya",
                                        "value": "Jawaban5"
                                    }
                                ],
                                "isRequired": true,
                                "populixType": "additionalQuestion"
                            },
                            {
                                "name": "question11",
                                "type": "rating",
                                "title": "Berikan rating dari 1 (tidak penting) sampai 5 (sangat penting) untuk faktor-faktor berikut dalam memilih snack:",
                                "isRequired": true,
                                "rateValues": [
                                    {
                                        "text": "1",
                                        "value": "1"
                                    },
                                    {
                                        "text": "2",
                                        "value": "2"
                                    },
                                    {
                                        "text": "3",
                                        "value": "3"
                                    },
                                    {
                                        "text": "4",
                                        "value": "4"
                                    },
                                    {
                                        "text": "5",
                                        "value": "5"
                                    }
                                ],
                                "populixType": "additionalQuestion"
                            },
                            {
                                "name": "question12",
                                "type": "rating",
                                "title": "Kemasan",
                                "isRequired": true,
                                "rateValues": [
                                    {
                                        "text": "1",
                                        "value": "1"
                                    },
                                    {
                                        "text": "2",
                                        "value": "2"
                                    },
                                    {
                                        "text": "3",
                                        "value": "3"
                                    },
                                    {
                                        "text": "4",
                                        "value": "4"
                                    },
                                    {
                                        "text": "5",
                                        "value": "5"
                                    }
                                ],
                                "populixType": "additionalQuestion"
                            },
                            {
                                "name": "question13",
                                "type": "rating",
                                "title": "Ukuran/Porsi",
                                "isRequired": true,
                                "rateValues": [
                                    {
                                        "text": "1",
                                        "value": "1"
                                    },
                                    {
                                        "text": "2",
                                        "value": "2"
                                    },
                                    {
                                        "text": "3",
                                        "value": "3"
                                    },
                                    {
                                        "text": "4",
                                        "value": "4"
                                    },
                                    {
                                        "text": "5",
                                        "value": "5"
                                    }
                                ],
                                "populixType": "additionalQuestion"
                            },
                            {
                                "name": "question14",
                                "type": "radiogroup",
                                "title": "Siapa yang biasanya memutuskan snack apa yang akan dibeli di rumah Anda?",
                                "choices": [
                                    {
                                        "text": "Saya sendiri",
                                        "value": "Jawaban1"
                                    },
                                    {
                                        "text": "Orang tua",
                                        "value": "Jawaban2"
                                    },
                                    {
                                        "text": "Pasangan",
                                        "value": "Jawaban3"
                                    },
                                    {
                                        "text": "Anak",
                                        "value": "Jawaban4"
                                    },
                                    {
                                        "text": "Lainnya",
                                        "value": "Jawaban5"
                                    }
                                ],
                                "isRequired": true,
                                "populixType": "additionalQuestion"
                            },
                            {
                                "name": "question15",
                                "type": "comment",
                                "title": "Apakah ada hal lain yang ingin Anda sampaikan tentang kebiasaan konsumsi snack Anda?",
                                "isRequired": true,
                                "populixType": "additionalQuestion"
                            }
                        ],
                        "visibleIf": null,
                        "description": ""
                    }
                ],
                "title": "Kebiasaan Konsumsi makanan manis dan hubungannya dengan mood yang baik",
                "triggers": [],
                "description": "Ingin mengetahui snack merek apa yang sering dikonsumsi, kapan terpikir untuk mengkonsumsi snack tersebut, apakah suka menyimpan stok snack tersebut, beli di mana, dan keputusan beli di siapa.",
                "textUpdateMode": "onTyping",
                "additionalQuestionsPlacement": "after_stimuli"
            }
        }
    }
}
Modified at 2025-05-19 08:44:15
Previous
Publish Study
Next
Update Study Status
Built with