Get Similar Survey List

Owned by Claudio Baldi
Last updated: Oct 08, 2024 by Piyush Khandelwal
50 min read

Similar Survey helps buyer to decided the best CPI based on previous study with common market and audience. The user will have the possibility to see the last three surveys with similar audience and check the AVG CPI that the study got complete.

 

List of features

  1. User want the ability to compare the new survey with similar studies already closed and/or invoiced

  2. Operator can change this range via Global Settings.

    1. LOI range (in %)

    2. IR range (in %)

    3. Field Time Range (in days)

  3. If the toggle is set to off then these ranges are not included in the search

  4. If toggle Field Time, LOI, and IR value is set to 0, then it will search for an exact match, otherwise search in range as per the value

  5. The API will return the 3 most similar projects in the last 3 / 6 or 9 months.

    1. Value of this should be Confgured from Global Settings.

 

Feature Flags:

  • Enable Similar Surveys (For search within the company)

  • Allow the search to all Marketplace inventory. ( For search Globally.)

Accessed By Only:

  • Buyer

  • Service Operator

 

API DOCS

End Points

Search Within The Company:-

{{url}}/buyers/v2/similar-projects

Search Globally:-

{{url}}/buyers/v2/similar-projects?global=1v2/similar-projects?global=1

  • NOTE: In this case the AVG CPI shown should be Supplier AVG CPI + the Margin of the account. We don’t want to show the price and the margin applied for another account.

 

Payload

// Payload Structure { "survey_localization": string, "completes_required": number, "expected_loi": number, "expected_ir": number, "field_time": number, "qualifications": [ { "qualification_name": string "qualification_code": number, "condition_codes": [ string(number) // "111", "112" .... ], "range_sets": [ { "from": number, "to": number, "units": number } ] // there will be one present either condition_codes or range_sets }, ], "quotas": [ { "required_count": number, "criteria": [ { "qualification_code": number, "condition_codes": [ string(number) // "111", "112", "113" ], "qualification_name": string }, { "qualification_code": 212, "range_sets": [ { "units": number, "to": number, "from": number } ], "qualification_name": string } ], "quota_category": "autoNested" } ] } // without qualification and quotas { "survey_localization": "US", "completes_required": 100, "expected_loi": 10, "expected_ir": 10, "field_time": 10, } // with qualification { "survey_localization": "US", "completes_required": 100, "expected_loi": 10, "expected_ir": 10, "field_time": 10, "qualifications": [ { "qualification_name": "Gender", "qualification_code": 211, "condition_codes": [ "111", "112" ] }, { "qualification_name": "Age", "qualification_code": 212, "range_sets": [ { "from": 18, "to": 99, "units": 311 } ] }, ] } // With Qualification and Quotas (Layered and Nested Both) { "survey_localization": "US", "completes_required": 100, "expected_loi": 10, "expected_ir": 10, "field_time": 10, "qualifications": [ { "qualification_name": "Gender", "qualification_code": 211, "condition_codes": [ "111", "112", "113" ] }, { "qualification_name": "Age", "qualification_code": 212, "range_sets": [ { "from": 18, "to": 99, "units": 311 } ] }, { "qualification_name": "Hispanic Origin", "qualification_code": 245, "condition_codes": [ "111", "112" ] } ], "quotas": [ { "required_count": 5, "criteria": [ { "qualification_code": 211, "condition_codes": [ "111" ], "qualification_name": "Gender" }, { "qualification_code": 212, "range_sets": [ { "units": 311, "to": 24, "from": 18 } ], "qualification_name": "Age" } ], "quota_category": "autoNested" }, { "required_count": 6, "criteria": [ { "qualification_code": 211, "condition_codes": [ "111" ], "qualification_name": "Gender" }, { "qualification_code": 212, "range_sets": [ { "units": 311, "to": 34, "from": 25 } ], "qualification_name": "Age" } ], "quota_category": "autoNested" }, { "required_count": 5, "criteria": [ { "qualification_code": 211, "condition_codes": [ "111" ], "qualification_name": "Gender" }, { "qualification_code": 212, "range_sets": [ { "units": 311, "to": 44, "from": 35 } ], "qualification_name": "Age" } ], "quota_category": "autoNested" }, { "required_count": 5, "criteria": [ { "qualification_code": 211, "condition_codes": [ "111" ], "qualification_name": "Gender" }, { "qualification_code": 212, "range_sets": [ { "units": 311, "to": 54, "from": 45 } ], "qualification_name": "Age" } ], "quota_category": "autoNested" }, { "required_count": 6, "criteria": [ { "qualification_code": 211, "condition_codes": [ "111" ], "qualification_name": "Gender" }, { "qualification_code": 212, "range_sets": [ { "units": 311, "to": 64, "from": 55 } ], "qualification_name": "Age" } ], "quota_category": "autoNested" }, { "required_count": 7, "criteria": [ { "qualification_code": 211, "condition_codes": [ "111" ], "qualification_name": "Gender" }, { "qualification_code": 212, "range_sets": [ { "units": 311, "to": 99, "from": 65 } ], "qualification_name": "Age" } ], "quota_category": "autoNested" }, { "required_count": 4, "criteria": [ { "qualification_code": 211, "condition_codes": [ "112" ], "qualification_name": "Gender" }, { "qualification_code": 212, "range_sets": [ { "units": 311, "to": 24, "from": 18 } ], "qualification_name": "Age" } ], "quota_category": "autoNested" }, { "required_count": 6, "criteria": [ { "qualification_code": 211, "condition_codes": [ "112" ], "qualification_name": "Gender" }, { "qualification_code": 212, "range_sets": [ { "units": 311, "to": 34, "from": 25 } ], "qualification_name": "Age" } ], "quota_category": "autoNested" }, { "required_count": 5, "criteria": [ { "qualification_code": 211, "condition_codes": [ "112" ], "qualification_name": "Gender" }, { "qualification_code": 212, "range_sets": [ { "units": 311, "to": 44, "from": 35 } ], "qualification_name": "Age" } ], "quota_category": "autoNested" }, { "required_count": 5, "criteria": [ { "qualification_code": 211, "condition_codes": [ "112" ], "qualification_name": "Gender" }, { "qualification_code": 212, "range_sets": [ { "units": 311, "to": 54, "from": 45 } ], "qualification_name": "Age" } ], "quota_category": "autoNested" }, { "required_count": 6, "criteria": [ { "qualification_code": 211, "condition_codes": [ "112" ], "qualification_name": "Gender" }, { "qualification_code": 212, "range_sets": [ { "units": 311, "to": 64, "from": 55 } ], "qualification_name": "Age" } ], "quota_category": "autoNested" }, { "required_count": 7, "criteria": [ { "qualification_code": 211, "condition_codes": [ "112" ], "qualification_name": "Gender" }, { "qualification_code": 212, "range_sets": [ { "units": 311, "to": 99, "from": 65 } ], "qualification_name": "Age" } ], "quota_category": "autoNested" }, { "required_count": 4, "criteria": [ { "qualification_code": 211, "condition_codes": [ "113" ], "qualification_name": "Gender" }, { "qualification_code": 212, "range_sets": [ { "units": 311, "to": 24, "from": 18 } ], "qualification_name": "Age" } ], "quota_category": "autoNested" }, { "required_count": 6, "criteria": [ { "qualification_code": 211, "condition_codes": [ "113" ], "qualification_name": "Gender" }, { "qualification_code": 212, "range_sets": [ { "units": 311, "to": 34, "from": 25 } ], "qualification_name": "Age" } ], "quota_category": "autoNested" }, { "required_count": 5, "criteria": [ { "qualification_code": 211, "condition_codes": [ "113" ], "qualification_name": "Gender" }, { "qualification_code": 212, "range_sets": [ { "units": 311, "to": 44, "from": 35 } ], "qualification_name": "Age" } ], "quota_category": "autoNested" }, { "required_count": 5, "criteria": [ { "qualification_code": 211, "condition_codes": [ "113" ], "qualification_name": "Gender" }, { "qualification_code": 212, "range_sets": [ { "units": 311, "to": 54, "from": 45 } ], "qualification_name": "Age" } ], "quota_category": "autoNested" }, { "required_count": 6, "criteria": [ { "qualification_code": 211, "condition_codes": [ "113" ], "qualification_name": "Gender" }, { "qualification_code": 212, "range_sets": [ { "units": 311, "to": 64, "from": 55 } ], "qualification_name": "Age" } ], "quota_category": "autoNested" }, { "required_count": 7, "criteria": [ { "qualification_code": 211, "condition_codes": [ "113" ], "qualification_name": "Gender" }, { "qualification_code": 212, "range_sets": [ { "units": 311, "to": 99, "from": 65 } ], "qualification_name": "Age" } ], "quota_category": "autoNested" }, { "required_count": 50, "criteria": [ { "qualification_code": 245, "condition_codes": [ "111" ], "qualification_name": "Hispanic Origin" } ], "quota_category": "layered" }, { "required_count": 50, "criteria": [ { "qualification_code": 245, "condition_codes": [ "112" ], "qualification_name": "Hispanic Origin" } ], "quota_category": "layered" } ] }

 

Response:-

// Response Structure [ { "ps_survey_id": number, "cmp": number, "title": string, "currency": { "fx": number, "symbol": string, }, "epc": number, "cpi": number, "completes_required": number, "field_time": number, "fielded": number, "qualifications": [ { "qualification_code": "$$item.qualification_code", "qualification_name": "$$item.q_name", "condition_codes": "$$item.conditions", // [] "range_sets": "$$item.range_sets" // [] } ], } ] // Example [ { "ps_survey_id": 17737, "cmp": 145, "title": "TEST-5", "currency": { "fx": 321, "symbol": "$" }, "epc": 0, "cpi": 42, "completes_required": 100, "fielded": 0, "field_time": 10, "qualifications": [ { "qualification_code": 211, "qualification_name": "Gender", "condition_codes": [ { "id": "111", "name": "Male" }, { "id": "112", "name": "Female" }, { "id": "113", "name": "Prefer not to say" } ], "range_sets": [] }, { "qualification_code": 212, "qualification_name": "Age", "condition_codes": [], "range_sets": [ { "units": 311, "to": 99, "from": 18 } ] }, { "qualification_code": 245, "qualification_name": "Hispanic Origin", "condition_codes": [ { "id": "111", "name": "Yes" }, { "id": "112", "name": "No" } ], "range_sets": [] } ], "survey_closed_date": 1725972741642 }, { "ps_survey_id": 17736, "cmp": 145, "title": "TEST-4", "epc": 0, "cpi": 42, "currency": { "fx": 321, "symbol": "$" }, "completes_required": 100, "fielded": 0, "field_time": 10, "qualifications": [ { "qualification_code": 211, "qualification_name": "Gender", "condition_codes": [ { "id": "111", "name": "Male" }, { "id": "112", "name": "Female" }, { "id": "113", "name": "Prefer not to say" } ], "range_sets": [] }, { "qualification_code": 212, "qualification_name": "Age", "condition_codes": [], "range_sets": [ { "units": 311, "to": 99, "from": 18 } ] }, { "qualification_code": 245, "qualification_name": "Hispanic Origin", "condition_codes": [ { "id": "111", "name": "Yes" }, { "id": "112", "name": "No" } ], "range_sets": [] } ], "survey_closed_date": 1725972741641 }, { "ps_survey_id": 17735, "cmp": 145, "title": "TEST 3", "currency": { "fx": 321, "symbol": "$" }, "epc": 0, "cpi": 42, "completes_required": 100, "fielded": 0, "field_time": 10, "qualifications": [ { "qualification_code": 211, "qualification_name": "Gender", "condition_codes": [ { "id": "111", "name": "Male" }, { "id": "112", "name": "Female" }, { "id": "113", "name": "Prefer not to say" } ], "range_sets": [] }, { "qualification_code": 212, "qualification_name": "Age", "condition_codes": [], "range_sets": [ { "units": 311, "to": 99, "from": 18 } ] }, { "qualification_code": 245, "qualification_name": "Hispanic Origin", "condition_codes": [ { "id": "111", "name": "Yes" }, { "id": "112", "name": "No" } ], "range_sets": [] } ], "survey_closed_date": 1725972741639 } ]