How to add parameters to the module URL?

How to add parameters to the module URL?

If you want to send out a discovery journey in a personal newsletter or on a page where the user is already logged in with an email, you can add an email parameter. This avoids the user having to enter their name and email on the info or end card, which increases the likelihood of data collection.

This guide will show you how.

Step 1

Log in to your favorite email and marketing automation platform. In this example, we are using MailChimp. Then, create your newsletter as usual.

Step 2

Then log in to your Roccai profile and click the share icon in the menu top left corner. Create a new link and copy the module by clicking the link icon.

Step 3

Add the link to your newsletter. It could be in a button like this:

Step 4

Then open User Specific Parameters in Roccai:

Step 5

Then, add a URL Parameter. It could be name, email, etc., but in this case, it is the email. Make sure that the parameter and type are identical. Then press COPY.

Step 6

Add the parameter to the end of the module URL like this. Add & and the parameter, equal to and *|EMAIL|* Here is an example:

MODULE URL&uQSTRuzDjNEetrrYsdHg=*|EMAIL|*

Step 7

Send a test email from Mailchimp:

Step 8

Try the discovery journey by clicking the button.

How to Export your Data with Zapier

How to Export your Data with Zapier

This guide will walk you through the steps to export your data from Roccai to your chosen dashboard platform. You can either use Roccai’s API directly or set up a scenario with Zapier or Make, depending on your platform.

Step 1: Create a Zapier Profile

Step 2: Schedule by Zapier

Since we do not automatically send data, Zapier needs to request it at scheduled intervals. To achieve this, you can use the Schedule by Zapier app, which allows you to define when Zapier should retrieve data from our API.

For example, you can set up Zapier to request data every hour instead of waiting for an automatic push. This ensures that the latest data is always available when needed.

Step 3: Search for Roccai

App & event

  • Choose Get Journeys in the event dropdown menu.
Account
  • In the Action tab, Connect a new account.

Find Your Token

  • Log in to your Roccai profile.
  • Go to company settings https://app.roccai.com/company-settings
  • Select API, press Generate Token, and copy the token.


Find Your Company Name
In this field, you can fill out your company name or something that you use to identify which account you are signed in to.

Action
Important: Handling Multiple Zapier Integrations

If you set Get Newest Data to True and have multiple Zapier integrations connected to the same module, you will need to create a separate Token for each Zap. This ensures that each Zap retrieves the correct and most recent data independently.

Locate the Module ID and Campaign ID:

  • The Module ID can be found here:
Roccai API for PowerBI
  • The Campaign ID is obtained by clicking the Share Icon in the menu, selecting the desired campaign, and clicking copy.
Test

Finally, test your trigger.

Step 4: Filter by Zapier

To handle if the Result returns an empty list, add the app Filter By Zapier. This will stop the zap from entering the loop with an empty list.

App & Event
Configure & test

The zap should only continue if the Result Exists.

Step 4: Loop through results

The list of user journeys is available within Result, therefore we need to loop through them in order to create a separate line for each journey.

App & Event

Add a new connection called Looping by Zapier and choose Create Loop From Line Items

Action

Under Action define the values you want to loop through.

Here is an example:

Test

Your data will come out like this

Step 5: Choose Your Connection

Select the desired connection for your data export. For example, to send data to Google Sheets:

  • Choose the Google Sheets zap.
  • Create a Google Sheet with the desired headers.
App & Event

Choose the Google Sheets event, for instance:

Account
  • Connect the sheet to Zapier.
Action
Test
  • Test the step to ensure the data is correctly imported into the sheet.

Step 6: Need More Help?

If you need further assistance exporting your data from Roccai, please contact us via chat support.

How to Export your Data with Make

How to Export your Data with Make

This guide shows how to export your data from Roccai into your dashboard platform. Depending on your platform, you can either use the API from Roccai and do it directly or set up a scenario with Zapier or Make.

Step 1

Please create a profile with Make (cheaper than Zapier) or login here.
Then, you press the button, Create a new scenario.

Step 2

Select the tool HTTP


And then select Make a Basic Auth Request.

Step 3

  • Log in to your Roccai profile.
  • Go to company settings https://app.roccai.com/company-settings
  • Select API, press Generate Token, and copy the token.

Step 4

In the HTTP Scenario in Make, you should then fill out the following:


Step 5

Then, add a URL Parameter. The next steps shown how to get the URL Parameter.

Step 6

Obtain a valid token to access the Roccai API. You can get your token under Settings and API: Here you also find the API Documentation with the different data you can extract.

Step 7

Locate the endpoint that provides the desired information. For instance the userInfo

The Module ID is found here:

Roccai API for PowerBI

The Campaign ID is found by clicking the Share Icon in the menu. Then click the row on the campaign you want to get the ID from and click copy to get the campaign ID

Fill in the details in the API documentation:

  • Authorization: doesn’t need to be filled out
  • ModuleId: Specify the required Module Id.
  • CampaignId: Specify the Campaign Id (CampaignId should only be used for some, such as decisions. It should not be used for products.)

Press the ‘Execute’ button to get a response.


Copy the generated Request URL from the response and add it to Make.

Step 8

If you need more help to export your data from Roccai, write to us in the chat.

How do I get an API in Roccai for PowerBI?

How do I get an API in Roccai for PowerBI?

Step 1 – Obtain API Token

1.1. Obtain a valid token to access the Roccai API. You can get your token under Company Settings and API:

  • Log in to your Roccai profile.
  • Go to company settings https://app.roccai.com/company-settings
  • Select API, press Generate Token, and copy the token.
Step 2 – Retrieve Data

2.1 Locate the endpoint that provides the desired information.

The Module ID is found here:

Roccai API for PowerBI

The Campaign ID is found by clicking the Share Icon in the menu. Then click the row on the campaign you want to get the ID from and click copy to get the campaign ID

2.2. Fill in the details in the API documentation:

  • Authorization: doesn’t need to be filled out
  • ModuleId: Specify the required Module Id.
  • CampaignId: Specify the Campaign Id (CampaignId should only be used for some, such as decisions. It should not be used for products.)

2.3. Press the ‘Execute’ button to get a response.

Step 3 – Copy the generated Request URL from the response.
Step 4 – Set Up Power BI

4.1. Open Microsoft Power BI.

4.2. Go to Home > Get Data > Web.

Step 5 – Configure Power BI connection

5.1. Choose the ‘Advanced’ option.

5.2. Paste the copied Request URL.

5.3. Make sure the url is api.roccai.com.

5.4 In the HTTP request parameters section:

  • Authorization Type: Set the authorization type as ‘bearer’ followed by the provided token number.
  • Content Type: Specify the ‘content type’ as ‘application/json;charset-utf=8’

5.5. Press ‘OK’ to confirm.

Step 6 – Display Result

After configuring the connection, Power BI will evaluate the query and the output will be displayed in Power BI.

If you need our help, please contact us via the chat in the bottom right corner.