Filter API Responses by Hidden Variables and Contact Attributes

You can now filter responses by hidden variables and contact attributes using the Responses API. This lets you fetch only the feedback you need, such as responses from a specific store, channel or customer segment, without pulling everything and filtering it yourself.

How it works

  • Hidden variables: Use the hidden variable name as the query parameter.
    store_location=Downtown,Airport
  • Contact attributes: Add the prefix contact_ to the attribute name.
    contact_plan=Pro,Enterprise
  • Multiple values: Separate values with commas to match any of them.

You can combine these with existing filters like surveyId, startDate and limit.

Example

GET /responses?store_location=Downtown,Airport&contact_plan=Pro,Enterprise

This returns responses from the Downtown or Airport stores, submitted by contacts on the Pro or Enterprise plan.

Use cases

  • Sync feedback for specific locations or regions into your BI tools
  • Analyse responses by customer plan, tier or segment
  • Build focused reports without extra filtering on your side

View the Responses API documentation →