Poradnik - Dokumentacja API

Parametr zewnętrzny – external_key

external_key to parametr w którym możesz przekazać zewnętrzny identyfikator, tak by później połączyć go z wypełnioną ankietą. 
Najczęściej przekazywany jest w nim unikalny identyfikator klienta (np. z internetowego systemu po zalogowaniu) lub źródło wizyty (np. facebook czy mailing).

Parametr z jest dodawany jako klasyczny parametr typu GET do URL-a ankiety.
Istnieje możliwość wielokrotnego wypełnienia ankiety z tym parametrem.
Parametr można stosować we wszystkich poziomach bezpieczeństwa ankiety

Przykładowe adresy URL

https://www.webankieta.pl/ankieta/123456/badanie-satysfakcji.html?external_key=facebook

http://ankieta.mojafirma.pl?external_key=0002371231189

 

Opis parametrów

 

Nazwa Opis
external_key  Jest to dowolny ciąg znaków alfanumerycznych. Dozwolone znaki to a-z, A-Z, 0-9, z wyłączeniem znaków diakrytycznych. Maksymalna długość       parametru external key to 31 znaków.

Prezentacja i analiza wyników

Jeżli parametr external_key zostanie przekazany w linku do ankiety, informacja ta pojawi się w następujących miejscach:

  • Przeglądanie pojedynczych arkuszy
  • Eksport surowych danych do CSV
  • Eksport surowych danych do XLSX
  • Eksport do SPSS

W przypadku surowych danych i pliku SPSS będzie to odpowiednio kolumna w Excelu lub dodatkowa zmiana V w SPSS.

External key w widgecie

external_key możesz przekazać też do wypełnienia widgeta, ale wymaga to drobnej pracy programistycznej.
Najczęśniej w ten sposób przekazywany jest unikalny identyfikator klienta (np. z internetowego systemu po zalogowaniu) lub inny parametr pozwalający na identyfikację wypełnienia.

Parametr jest dodawany przez zmienną JavaScript’ową o ustalonej nazwie: widget_external_key.
Zmienną należy zdefiniować przed załadowaniem kodu widgetu.
Zmienna musi być zdefiniowana na każdej podstronie na której wyświetlany jest widget.

Przykładowy kod

Na poniższym przykładzie abcd jest unikalnym identyfikatorem widgeta, zawartym w przygotowanym do pobrania kodzie, który można znaleźć w panelu użytkownika, a user12345 jest unikalnym identyfikatorem użytkownika z systemu CRM.

<script type="text/javascript">
    var widget_external_key = 'user12345';
</script>
<script type="text/javascript">(function(d,s,u,i){var e=d.createElement(s), p=d.getElementsByTagName(s)[0];e.async=1;e.src=u+'#id='+i; p.parentNode.insertBefore(e,p);})(document,'script','//cloud.webankieta.pl/scripts/widget/script.min.js', 'abcd');</script>

Czy ten artykuł był pomocny?

Dziękujemy za udzielenie odpowiedzi