Retrieving the list of suppliers for a Survey

Overview

Every survey in PureSpectrum has a list of suppliers that send sample. To check the list of suppliers, and their performance on a survey, you may use this endpoint.

Use

Use the endpoint at GET /surveys/:surveyId/suppliers to fetch the list of suppliers and their performance on survey.

Important Considerations

None

Request


GET $apihost/$basepath/surveys/:surveyId/suppliers

($apihost is the environment against which you are testing, and $basepath is the base path with the api version. All Buy API calls will require access-token parameter in the header) 
Result 


Response Code

200

Response Body

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 [ { "group_ref": "abc", "group_name": "PS suppliers", "completes_goal": 100, "remaining": 100, "fielded": 0, "cpi": 6, "intent": { "intent_value": null, "intent_not_set": [ 1, 23 ], "intent_denied": [], "intent_accepted": [] }, "suppliers": [ { "id": 1, "name": "Supplier 1" }, { "id": 23, "name": "Supplier 23" } ] }, { "group_ref": null, "group_name": null, "completes_goal": 100, "remaining": 100, "fielded": 0, "cpi": 4, "last_start_date": "", "intent": { "intent_value": 0 }, "suppliers": [ { "id": 16, "name": "Supplier 16" } ] } ]

 

Request: 

GET $apihost/$basepath/surveys/:surveyId/suppliers?stats=1

Query Params:

stats = 1/0 ( 1 to get performance / 0 to not get perfromance )

($apihost is the environment against which you are testing, and $basepath is the base path with the api version. All Buy API calls will require access-token parameter in the header) 
Result 


Response Code

200

Response Body

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 [ { "group_ref": "abc", "group_name": "PS suppliers", "completes_goal": 100, "remaining": 100, "fielded": 0, "cpi": 6, "intent": { "intent_value": 50, "intent_not_set": [ 1 ], "intent_denied": [ 23 ], "intent_accepted": [] }, "suppliers": [ { "id": 1, "name": "Supplier 1" }, { "id": 23, "name": "Supplier 23" } ], "performance": [ { "name": "PS_Termination_Core", "count": 1, "percentage_of_supplier_total": 11, "supplier_share_status": 100 }, { "name": "PS_Side_In_Progress", "count": 2, "percentage_of_supplier_total": 22, "supplier_share_status": 100 }, { "name": "Complete", "count": 6, "percentage_of_supplier_total": 66, "supplier_share_status": 75 } ], "valid_clicks": 6, "valid_click_cost": 3.5, "valid_click_percentage": 67, "total_click_cost": 2.33 }, { "group_ref": null, "group_name": null, "completes_goal": 100, "remaining": 98, "fielded": 2, "cpi": 4.17, "last_start_date": 1576129870101, "intent": { "intent_value": 32 }, "suppliers": [ { "id": 190, "name": null } ], "performance": [ { "name": "Complete", "count": 2, "percentage_of_supplier_total": 100, "supplier_share_status": 25 } ], "valid_clicks": 2, "valid_click_cost": 2.92, "valid_click_percentage": 100, "total_click_cost": 2.92 } ]