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

Participant Criteria

Respondent Criteria Object#

This object defines the structure and attributes of a respondent criterion used for filtering and targeting participants.

Fields#

question (string)
The question that will be displayed to the participant. This represents the prompt for selecting a particular criterion (e.g. Mempunyai Social Media Account).
description (string)
A description of the selected criterion, often mirroring the question but can be more detailed or formatted differently (e.g. Pilih jika responden memiliki akun sosial media).
parentKey (string)
The key that identifies the main category of the criterion (e.g., Gender, Age, Province).
parentValue (string | null)
The value associated with the selected criterion (e.g., "Laki-Laki", "Upper"). If the criterion involves a range or general input (like Age), this may be null.
CriteriaChildData (array of objects)
A list of child criteria (if any) that are dependent on the current parent criterion. Each child includes:
childKey: Key of the child criterion.
childValue: Value of the child criterion.
inputType (string)
Indicates the type of input to be rendered in the UI. Available values:
"RADIO" – Allows the selection of only one option.
"CHECKBOX" – Allows the selection of one or more options.
"RANGE" – Used for range-type inputs (e.g., age: start from 10 - 80 years old).
"MULTI_SELECT" – Allows the selection of one or more options.
isMultiple (boolean)
Indicates whether multiple subcriteria can be selected:
true – Multiple subcriteria selections are allowed.
false – Only one subcriterion may be selected.
type (string)
Specifies the category type of the criterion:
"GENERAL" – The subcategory values are broad/generalized (e.g., Yes, No).
"SPECIFIC" – The subcategory values are specific options (e.g., Upper, Middle, Lower).

Example#

Below is an example of the respondent criteria object. Please note that this is only a sample. The complete list of criteria can be retrieved through the Get Criteria endpoint.
[
  {
    "parentKey": "Gender",
    "parentValue": "Laki-Laki",
    "type": "SPECIFIC",
    "inputType": "CHECKBOX",
    "question": "Jenis kelamin",
    "description": "Jenis kelamin",
    "isMultiple": true,
    "CriteriaChildData": [],
    "label": "Laki-Laki"
  },
  {
    "parentKey": "Gender",
    "parentValue": "Perempuan",
    "type": "SPECIFIC",
    "inputType": "CHECKBOX",
    "question": "Jenis kelamin",
    "description": "Jenis kelamin",
    "isMultiple": true,
    "CriteriaChildData": [],
    "label": "Perempuan"
  },
  {
    "parentKey": "Age",
    "parentValue": null,
    "type": "SPECIFIC",
    "inputType": "RANGE",
    "question": "Usia",
    "description": "Usia",
    "isMultiple": false,
    "CriteriaChildData": [],
    "label": null
  },
  {
    "parentKey": "SocialEconomicStatusGroup",
    "parentValue": "Upper",
    "type": "SPECIFIC",
    "inputType": "MULTI_SELECT",
    "question": "Status Ekonomi Sosial",
    "description": "Status Ekonomi Sosial",
    "isMultiple": true,
    "CriteriaChildData": [],
    "label": "Upper"
  },
  {
    "parentKey": "SocialEconomicStatusGroup",
    "parentValue": "Middle",
    "type": "SPECIFIC",
    "inputType": "MULTI_SELECT",
    "question": "Status Ekonomi Sosial",
    "description": "Status Ekonomi Sosial",
    "isMultiple": true,
    "CriteriaChildData": [],
    "label": "Middle"
  },
  {
    "parentKey": "SocialEconomicStatusGroup",
    "parentValue": "Lower",
    "type": "SPECIFIC",
    "inputType": "MULTI_SELECT",
    "question": "Status Ekonomi Sosial",
    "description": "Status Ekonomi Sosial",
    "isMultiple": true,
    "CriteriaChildData": [],
    "label": "Lower"
  },
  {
    "parentKey": "Province",
    "parentValue": "Bali",
    "type": "SPECIFIC",
    "inputType": "CHECKBOX",
    "question": "Tempat Tinggal Saat Ini",
    "description": "Tempat Tinggal Saat Ini",
    "isMultiple": true,
    "label": "Bali",
    "CriteriaChildData": [
      {
        "childKey": "Domicile",
        "childValue": "Denpasar"
      }
    ]
  },
  {
    "parentKey": "Province",
    "parentValue": "Bangka Belitung",
    "type": "SPECIFIC",
    "inputType": "CHECKBOX",
    "question": "Tempat Tinggal Saat Ini",
    "description": "Tempat Tinggal Saat Ini",
    "isMultiple": true,
    "label": "Bangka Belitung",
    "CriteriaChildData": []
  },
  {
    "parentKey": "Province",
    "parentValue": "Banten",
    "type": "SPECIFIC",
    "inputType": "CHECKBOX",
    "question": "Tempat Tinggal Saat Ini",
    "description": "Tempat Tinggal Saat Ini",
    "isMultiple": true,
    "label": "Banten",
    "CriteriaChildData": [
      {
        "childKey": "Domicile",
        "childValue": "Serang"
      },
      {
        "childKey": "Domicile",
        "childValue": "Tangerang"
      },
      {
        "childKey": "Domicile",
        "childValue": "Tangerang Selatan"
      }
    ]
  },
  {
    "parentKey": "Province",
    "parentValue": "Bengkulu",
    "type": "SPECIFIC",
    "inputType": "CHECKBOX",
    "question": "Tempat Tinggal Saat Ini",
    "description": "Tempat Tinggal Saat Ini",
    "isMultiple": true,
    "label": "Bengkulu",
    "CriteriaChildData": []
  },
  {
    "parentKey": "Province",
    "parentValue": "DI Yogyakarta",
    "type": "SPECIFIC",
    "inputType": "CHECKBOX",
    "question": "Tempat Tinggal Saat Ini",
    "description": "Tempat Tinggal Saat Ini",
    "isMultiple": true,
    "label": "DI Yogyakarta",
    "CriteriaChildData": [
      {
        "childKey": "Domicile",
        "childValue": "Sleman"
      },
      {
        "childKey": "Domicile",
        "childValue": "Yogyakarta"
      }
    ]
  },
  {
    "parentKey": "Province",
    "parentValue": "DKI Jakarta",
    "type": "SPECIFIC",
    "inputType": "CHECKBOX",
    "question": "Tempat Tinggal Saat Ini",
    "description": "Tempat Tinggal Saat Ini",
    "isMultiple": true,
    "label": "DKI Jakarta",
    "CriteriaChildData": [
      {
        "childKey": "Domicile",
        "childValue": "Jakarta Barat"
      },
      {
        "childKey": "Domicile",
        "childValue": "Jakarta Pusat"
      },
      {
        "childKey": "Domicile",
        "childValue": "Jakarta Selatan"
      },
      {
        "childKey": "Domicile",
        "childValue": "Jakarta Timur"
      },
      {
        "childKey": "Domicile",
        "childValue": "Jakarta Utara"
      }
    ]
  },
  {
    "parentKey": "SmokingKey",
    "parentValue": "Ya",
    "type": "GENERAL",
    "inputType": "RADIO",
    "question": "Merokok",
    "description": "Merokok",
    "isMultiple": true,
    "CriteriaChildData": [],
    "label": "Ya"
  },
  {
    "parentKey": "SmokingKey",
    "parentValue": "Tidak",
    "type": "GENERAL",
    "inputType": "RADIO",
    "question": "Merokok",
    "description": "Merokok",
    "isMultiple": true,
    "CriteriaChildData": [],
    "label": "Tidak"
  },
  {
    "parentKey": "DigitalBankAccountKey",
    "parentValue": "Ya",
    "type": "GENERAL",
    "inputType": "RADIO",
    "question": "Mempunyai Digital Bank Account",
    "description": "Pilih Digital Bank Account responden",
    "isMultiple": true,
    "CriteriaChildData": [],
    "label": "Ya"
  },
  {
    "parentKey": "DigitalBankAccountKey",
    "parentValue": "Tidak",
    "type": "GENERAL",
    "inputType": "RADIO",
    "question": "Mempunyai Digital Bank Account",
    "description": "Pilih Digital Bank Account responden",
    "isMultiple": true,
    "CriteriaChildData": [],
    "label": "Tidak"
  },
  {
    "parentKey": "Religion",
    "parentValue": "Islam",
    "type": "SPECIFIC",
    "inputType": "CHECKBOX",
    "question": "Agama",
    "description": "Agama",
    "isMultiple": true,
    "CriteriaChildData": [],
    "label": "Islam"
  },
  {
    "parentKey": "Religion",
    "parentValue": "Kristen Protestan",
    "type": "SPECIFIC",
    "inputType": "CHECKBOX",
    "question": "Agama",
    "description": "Agama",
    "isMultiple": true,
    "CriteriaChildData": [],
    "label": "Kristen Protestan"
  },
  {
    "parentKey": "Religion",
    "parentValue": "Katolik",
    "type": "SPECIFIC",
    "inputType": "CHECKBOX",
    "question": "Agama",
    "description": "Agama",
    "isMultiple": true,
    "CriteriaChildData": [],
    "label": "Katolik"
  },
  {
    "parentKey": "Religion",
    "parentValue": "Memilih tidak menjawab",
    "type": "SPECIFIC",
    "inputType": "CHECKBOX",
    "question": "Agama",
    "description": "Agama",
    "isMultiple": true,
    "CriteriaChildData": [],
    "label": "Memilih tidak menjawab"
  },
  {
    "parentKey": "Religion",
    "parentValue": "Hindu",
    "type": "SPECIFIC",
    "inputType": "CHECKBOX",
    "question": "Agama",
    "description": "Agama",
    "isMultiple": true,
    "CriteriaChildData": [],
    "label": "Hindu"
  },
  {
    "parentKey": "Religion",
    "parentValue": "Budha",
    "type": "SPECIFIC",
    "inputType": "CHECKBOX",
    "question": "Agama",
    "description": "Agama",
    "isMultiple": true,
    "CriteriaChildData": [],
    "label": "Budha"
  },
  {
    "parentKey": "Religion",
    "parentValue": "Lainnya",
    "type": "SPECIFIC",
    "inputType": "CHECKBOX",
    "question": "Agama",
    "description": "Agama",
    "isMultiple": true,
    "CriteriaChildData": [],
    "label": "Lainnya"
  },
  {
    "parentKey": "Religion",
    "parentValue": "Atheis",
    "type": "SPECIFIC",
    "inputType": "CHECKBOX",
    "question": "Agama",
    "description": "Agama",
    "isMultiple": true,
    "CriteriaChildData": [],
    "label": "Atheis"
  },
  {
    "parentKey": "Religion",
    "parentValue": "Kong Hu Cu",
    "type": "SPECIFIC",
    "inputType": "CHECKBOX",
    "question": "Agama",
    "description": "Agama",
    "isMultiple": true,
    "CriteriaChildData": [],
    "label": "Kong Hu Cu"
  }
]
Modified at 2025-08-20 10:06:26
Previous
Authentication
Next
Publish Study
Built with