Skip to main content

URL Parameters

Amanda Cross
Updated

URL parameters pass information directly into Ringba for reporting and integration with other software platforms.

For example, information you may want to pass into Ringba could be an affiliate ID or keyword.

Passing specific information into Ringba about your users lets you sort and group by this data in the reporting interface. The more detailed the information you pass into Ringba, the more detailed and flexible Ringba reporting system becomes.

Once linked to the campaign, Ringba captures this data using the Ringba JavaScript Call Tracking Tag. 

Get the URL Parameter Format

To create and use a URL parameter, you must know the exact format of the data you are receiving. If the URL parameter has an incorrect format, the data will not be found. To get the correct URL parameter format:

  1. Go to Reporting > Default.
  2. Under Call Details section, search for a call that has the desired data attached.
  3. Select the Tags tab and search for the data under User section.
    The data collected on this example is Zipcode:
  4. Hover your mouse over the parameter and a copy-to-clipboard icon appears. Click the icon to copy the parameter format:

    In this example, the parameter is being sent as zip_code.

    Note: There are multiple formats you can use to send and receive a parameter. We highly recommend using the copy/paste method in the exact format so the data can be verified correctly.

Create a URL Parameter

To create a Ringba URL Parameter:

  1. Navigate to URL Parameters under Integrations in the main menu.
  2. Click Create URL Parameter.
  3. Configure the URL Parameter options:
    • URL Parameter: Paste the parameter format here.
    • Reporting Menu Name: Set this to user, as the data is being displayed under User section in the Tags tab for the call details.
    • Report Menu Name: Paste the parameter format here.
      Example on the "zip_code" parameter mentioned on the previous section:
  4. Click Create to create and save the URL Parameter.

Tip: You can also URL parameters inside Campaigns under the URL Parameters section.

Add a URL Parameter to a Campaign

To add a URL parameter to a Campaign:

  1. Navigate to Manage Campaigns from the main menu and find the Campaign.
  2. Click Add URL Parameter under URL Parameters.
  3. Select the URL Parameter and click Add.

Related articles