It is possible to use both a single-user API key and a multi-user API key.
If the “sub_branding_id” parameter is not passed, all merchants assigned to the API key must share the same customer survey. However, if the “sub_branding_id” parameter is passed, the survey results will belong to that specific sub-branding.
If multiple sub-branding IDs are passed, they must all have the same customer survey.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
api_key | string | ✅ Yes | API access key. Example: "a46dfc0e-4b59-448d-8a41-0745af6458ff" |
date_from | string (ISO-8601) | ✅ Yes | Returns surveys for dates greater than or equal to the passed value. Example: "2022-01-01" |
date_to | string (ISO-8601) | ✅ Yes | Returns surveys for dates less than or equal to the passed value. Example: "2020-01-31" |
sub_branding_id | int | ❌ No | Returns surveys belonging to the passed sub-branding. Example: 11 |
sub_branding_id_2 | int | ❌ No | Sub-branding can be passed multiple times. In this case, all related surveys will be returned. Example: 12 |