Quantclix API DOCUMENTATION

Introduction

The Demand API (DAI) is revolutionizing the way market research surveys are distributed and data is collected. This innovative system serves as a comprehensive solution for both clients and suppliers, streamlining the processes involved in market research.

For Clients: Pushing Demand in Quantclix Marketplace

Clients looking to distribute their surveys can now push their demand into the Quantclix Marketplace with ease. Here are some key benefits:

Efficient Distribution: Clients can seamlessly integrate their surveys into the marketplace, reaching a wider audience without the typical logistical hurdles.
Targeted Reach: The system allows for precise targeting, ensuring that surveys reach the intended demographic, thus improving the quality of the data collected.
Real-time Monitoring: Clients can track the progress and performance of their surveys in real-time, enabling them to make adjustments as needed.

For Suppliers: Pulling Survey Inventory

Suppliers, on the other hand, can benefit from the ability to pull survey inventory directly from the marketplace. This capability provides several advantages:

Increased Opportunities: Suppliers have access to a vast pool of survey inventories, allowing them to select those that best fit their capabilities and interests.
Flexible Participation: Suppliers can choose surveys based on availability and relevance, optimizing their workload and resources.
Enhanced Data Collection: With streamlined access to diverse survey inventories, suppliers can efficiently gather and analyze data, leading to more insightful research outcomes.

Integration of Survey Distribution and Data Collection

The integration provided by the Demand API (DAI) represents a significant advancement in the field of market research. Here’s how it impacts the overall process:

Seamless Workflow: By combining survey distribution with data collection, the DAI creates a more cohesive and less fragmented workflow, reducing time and effort for both clients and suppliers.
Improved Data Quality: The enhanced targeting and real-time monitoring capabilities ensure that the data collected is both relevant and accurate.
Scalable Solutions: The platform is designed to handle varying scales of survey demands, making it suitable for both large enterprises and smaller businesses.

In conclusion, the Demand API (DAI) offers a robust and efficient solution for automating market research surveys, bringing together the needs of clients and suppliers in a dynamic marketplace environment. This advancement not only improves the process but also enhances the quality of insights gained from market research efforts.

Authentication

Token-based authentication in the request headers is used by the API that is covered in this documentation. Clients must provide a token (given to them during integration) in the Authorisation header of their HTTP requests in order to interact with the API endpoints and access protected resources. This token provides authenticated access to the features of the API and acts as a secure identity.

Clients can safely authenticate their requests and confidently use the API's functionalities by conforming to this authentication protocol.

apikey {{APIkey}}

token {{Token}}

DEMAND API

POST /endpoints/create_project

https://api.quantclix.com/webservices/

This request will create a new survey with the provided details like project name, survey name, the number of completes, and the survey's status, and it will return the created survey details upon success.

Parameters

Name	Located in	Description	Required	Schema
survey_id	body	Unique Survey ID	Yes	string
survey_name	body	Project name for the survey	Yes	string
survey_country	body	Country for the survey	Yes	string
survey_language	body	Language associated with the survey	Yes	string
survey_category	body	Survey category	Yes	string
survey_currency	body	Survey Currency	Yes	string
audience_type	body	Audiance Type	yes	string
collects_pii	body	PII collection	No	string
incidence_rate	body	Incidence Rate	Yes	decimal
length_of_interview	body	Length of interview	Yes	integer
cost_per_interview	body	CPI	Yes	integer
complete_needed	body	Complete Needed	Yes	integer
survey_quota_calc_type	body	Type	No	string
live_click	body	Live click	No	integer
test_click	body	Test click	Yes	integer
project_start_date	body	Project Start Date	Yes	string
project_end_date	body	Project End Date	Yes	string
entry_live_url	body	Entry Link	Yes	string
qualifications	body	Qualification	Yes

Request Body

 {
  "survey_id": "7361",
"survey_name": "Test",
"survey_country": "India",
"survey_language": "English",
"survey_category": "B2B",
"survey_currency": "USD",
"audience_type": "B2C",
"collects_pii": "No",
"incidence_rate": "80",
"length_of_interview": "15",
"cost_per_interview": "1",
"complete_needed": "100",
"survey_quota_calc_type": "completes",
"live_click": null,
"test_click": null,
"project_start_date": "2024-11-26",
"project_end_date": "2024-11-30",
"entry_live_url":"http:www.domain.com?uid=[identifier]", "entry_test_url":"http:www.domain.com?uid=[identifier]",
"qualifications": {
"question": ["1"],
"option": {
},
"1": ["1-1", "1-2", "1-3"]
"option_quota": {
"3293":{
"1-1": "0",
"1-2": "0",
"1-3": "0"
}
}
},
"survey_description": null
}

Response Body

{
    "status": "success",
    "data": {
        "result": {
          "survey_id": "7361",
          "survey_name": "Test",
          "survey_country": "India",
          "survey_language": "English",
          "survey_category": "B2B",
          "survey_currency": "USD",
          "audience_type": "B2C",
          "collects_pii": "No",
          "incidence_rate": "80",
          "length_of_interview": "15",
          "cost_per_interview": "1",
          "complete_needed": "100",
          "survey_quota_calc_type": "completes",
          "live_click": null,
          "test_click": null,
          "project_start_date": "2024-11-26",
          "project_end_date": "2024-11-30",
          "entry_live_url":"http:www.domain.com?uid=[identifier]", "entry_test_url":"http:www.domain.com?uid=[identifier]",
          "qualifications": {
          "question": ["1"],
          "option": {
          },
          "1": ["1-1", "1-2", "1-3"]
          "option_quota": {
          "3293":{
          "1-1": "0",
          "1-2": "0",
          "1-3": "0"
          }
          }
          },
          "survey_description": null
        }
    }
}

Responses

Code	Description
201	Successful response
400	Bad request
401	Unauthorized

POST /endpoints/create_project:surveyID

https://api.quantclix.com/webservices/

This API updates an existing survey by surveyid. It allows you to modify details such as project name, survey name, status, completes, and more.

Parameters

Name	Located in	Description	Required	Schema
survey_id	body	Unique Survey ID	Yes	string
survey_name	body	Project name for the survey	Yes	string
survey_country	body	Country for the survey	Yes	string
survey_language	body	Language associated with the survey	Yes	string
survey_category	body	Survey category	Yes	string
survey_currency	body	Survey Currency	Yes	string
audience_type	body	Audiance Type	yes	string
collects_pii	body	PII collection	No	string
incidence_rate	body	Incidence Rate	Yes	decimal
length_of_interview	body	Length of interview	Yes	integer
cost_per_interview	body	CPI	Yes	integer
complete_needed	body	Complete Needed	Yes	integer
survey_quota_calc_type	body	Type	No	string
live_click	body	Live click	No	integer
test_click	body	Test click	Yes	integer
project_start_date	body	Project Start Date	Yes	string
project_end_date	body	Project End Date	Yes	string
entry_live_url	body	Entry Link	Yes	string
qualifications	body	Qualification	Yes

Request Body

 {
  "survey_id": "7361",
"survey_name": "Test",
"survey_country": "India",
"survey_language": "English",
"survey_category": "B2B",
"survey_currency": "USD",
"audience_type": "B2C",
"collects_pii": "No",
"incidence_rate": "80",
"length_of_interview": "15",
"cost_per_interview": "1",
"complete_needed": "100",
"survey_quota_calc_type": "completes",
"live_click": null,
"test_click": null,
"project_start_date": "2024-11-26",
"project_end_date": "2024-11-30",
"entry_live_url":"http:www.domain.com?uid=[identifier]", "entry_test_url":"http:www.domain.com?uid=[identifier]",
"qualifications": {
"question": ["1"],
"option": {
},
"1": ["1-1", "1-2", "1-3"]
"option_quota": {
"3293":{
"1-1": "0",
"1-2": "0",
"1-3": "0"
}
}
},
"survey_description": null
}

Response Body

{
    "status": "success",
    "data": {
        "result": {
          "survey_id": "7361",
          "survey_name": "Test",
          "survey_country": "India",
          "survey_language": "English",
          "survey_category": "B2B",
          "survey_currency": "USD",
          "audience_type": "B2C",
          "collects_pii": "No",
          "incidence_rate": "80",
          "length_of_interview": "15",
          "cost_per_interview": "1",
          "complete_needed": "100",
          "survey_quota_calc_type": "completes",
          "live_click": null,
          "test_click": null,
          "project_start_date": "2024-11-26",
          "project_end_date": "2024-11-30",
          "entry_live_url":"http:www.domain.com?uid=[identifier]", "entry_test_url":"http:www.domain.com?uid=[identifier]",
          "qualifications": {
          "question": ["1"],
          "option": {
          },
          "1": ["1-1", "1-2", "1-3"]
          "option_quota": {
          "3293":{
          "1-1": "0",
          "1-2": "0",
          "1-3": "0"
          }
          }
          },
          "survey_description": null
        }
    }
}

Responses

Code	Description
201	Successful response
400	Bad request
401	Unauthorized

Supply API

GET /supplier/send_supplier_data

https://api.quantclix.com/webservices/

This API retrieves a list of surveys that are currently live (active and running) and users to fetch information about all ongoing surveys.

Parameters

Name	Located in	Description	Required	Schema
survey_id	body	Unique identifier for the survey	Yes	integer
survey_code	body	Survey Code	Yes	string
survey_name	body	Survey Name	Yes	string
survey_country	body	Survey Country	Yes	string
survey_language	body	Survey Language	Yes	string
survey_category	body	Survey Category	No	string
survey_currency	body	Survey Currency	Yes	string
audience_type	body	Audience Type	Yes	string
Collects_pii	body	PII Collection	No	string
application_download	body	Application download	No	string
facial_coding	body	Facial Coding	No	string
incidence_rate	body	Incident Rate	Yes	integer
length_of_interview	body	LOI	Yes	integer
Cost_per_interview	body	Cost Per Interview	Yes	decimal
Complete_needed	body	Complete Needed	Yes	integer
Survey_quota_calc_type	body	Survey Quota Captured Type	No	string
live_click_quota	body	Live Click Quota	Yes	integer
test_click_quota	body	Test Click Quota	Yes	integer
survey_start_date	body	Survey Start Date	Yes	date
survey_end_date	body	Survey End Date	Yes	date
entry_live_url	body	Live survey link	Yes	URL string
entry_test_url	body	Test survey link	Yes	URL string
Survey_status	body	Survey Status	Yes	string
qualifications	body	Qualification	Yes	array
Survey_description	body	Survey Description	No	string

Response Body


{
    "status": "success",
    "data": [
        {
          "survey_id": "2",
          "survey_code": "QUANT2",
          "survey_name": "Test 17-10-24_1",
          "survey_country":"United States",
          "survey_language": "English",
          "survey_category": "B2B",
          "survey_currency": "USD",
          "audience_type": "B2B",
          "collects_pii": "No",
          "application_download": "No",
          "facial_coding": "No",
          "incidence_rate": "10",
          "length_of_interview":"10",
          "cost_per_interview": "0.00",
          "complete_needed": "0",
          "survey_quota_calc_type": "0",
          "live_click_quota": "0",
          "test_click_quota": "0",
          "survey_start_date":"2024-10-17",
          "survey_end_date":"2025-10-16",
          "entry_live_url":"{survey_entry_live_url}",
          "entry_test_url":"{survey_entry_test_url}",
          "survey_status": "Live",
          "qualifications": {
          "question": [
          "7011",
          "7012"
          "option": {
          "7011": [
          "7011-1",
          "7011-2"
          ]
          },
          "option_quota": {
          "7011": {
          "7011-1": "5",
          "7011-2":"6"
          }
          }
          },
          "survey_description": "test data"
        }
}

Responses

Code	Description
200	Successful response
500	Internal server Error

GET /supplier/get_master_data/question

https://api.quantclix.com/webservices/

This API retrieves the qualification.

Parameters

Name	Located in	Description	Required	Schema
ID	body	Unique identifier for the question	Yes	integer
Country	body	Country Id	Yes	integer

Response Body

{
    "status": "success",
    "data": [{ 
            "id": "1", 
            "country": "6", 
            "language": "1", 
            "control_type": "7", 
            "title": "AGE", 
            "question": "What is your age?", 
            "mapped_option": { 
               "1-1": "" 
            }, 
            "from_range": 18, 
            "to_range": 99 
        }, 
        { 
            "id": "2", 
            "country": "6", 
            "language": "1", 
            "control_type": "1", 
            "title": "GENDER", 
            "question": "Are you...?", 
            "mapped_option": { 
                "2-1": "Male", 
                "2-2": "Female" 
            }, 
            "from_range": null, 
            "to_range": null 
        }] 

}

Responses

Code	Description
200	Successful response
400	Bad request
401	Unauthorized