Filtering by email addresses and names in SurveyMonkey's API v3

Question

I'm upgrading my application from SurveyMonkey's API v2 to v3 and using the liogi/surveymonkey-api-v3 library to wrap around my API calls and have run into a problem.

The email, first_name, and last_name parameters for such endpoints as GET /surveys/{id}/responses/bulk seem to be ignored. No matter what value I enter for them, no responses get filtered out of my results.

Is this a bug?

Answer 1

Yes adding those as GET parameters in your request should filter responses by that recipient information.

For example:

/v3/surveys/<survey_id>/responses/[email protected]

Will return responses for survey <survey_id> where the recipient had email [email protected]. Note that only collectors of type email invitation have contact information that you can filter by. So responses taken by weblink will never have that data.

I just tested it out on the bulk endpoint and it successfully filtered it to just the one response with the email I used. I would first try to track the request your library is making to make sure it is sending the proper request format, if the request is proper and it still isn't filtering I would contact SurveyMonkey with more details about your request as in that case it'd likely be a bug.