---
title: "Passing URL Identifiers to Biz Core"
canonical: "https://bizcore.refined.site/space/BCKB/1986101266/Passing%20URL%20Identifiers%20to%20Biz%20Core"
format: markdown
---
> Macro (toc)
# **Overview**
Biz Core is designed to automatically capture URL identifier information and incorporate it into reports, providing valuable lead insights to subscribers. This feature allows subscribers to set their preferred URL identifiers before sharing the application form with their customers. The URL identifiers are then included in the Reports section of Biz Core, so subscribers can track the effectiveness of their marketing efforts by identifying the lead sources and campaigns that generate the most conversions, including clicks from Google Ads.
---
# **Manually Adding URL Identifiers**
Users can add identifiers to the URL of the application form by encoding them as query string parameters, these will be passed into Biz Core. There are two kinds of identifiers available:
## **Explicit Identifiers**
Adding these identifier parameters to the URL of an application form will pass them directly into Biz Core, where they will be attached to each Lead, and will be visible on the Lead Summary and within the Reports workspace. Users can filter, sort and manipulate data based on these explicit identifiers directly from the portal.
When [sharing or embedding](https://bizcore.refined.site/space/BCKB/1776615437/Application+Form+Setup#Share-&-Embed-Application-Form) an Application Form, the URL linking to the application will be formatted as:
`https://portal.bizcore.com.au/(apply:application-form)?apiKey=a56a731a-552b8-1491-fd6a-705817cecb&apiKeyId=e308c529-ciqq-3260-dfqx-971af977c605&formId=c198ce3c9-b598-b0eded9-be76e9f4033d`
The same link will be contained in an ``
> ℹ️ The above URLs are for demonstration purposes only, subscribers should only use the specific [link or embed code](https://bizcore.refined.site/space/BCKB/1776615437/Application+Form+Setup#Share-&-Embed-Application-Form) generated within their Biz Core subscription.
Subscribers can add up to three in-built identifiers to the URL, these are:
- `leadSource=`
- `campaign=`
- `leadMedium=`
Check the **Encoding **section below to ensure the plain-text is in an appropriate URL-encoded format, then add the analytical information to pass to Biz Core after the `=` symbol, for example:
- `leadSource=SEO`
- `campaign=June2020`
- `leadMedium=email`
Users can then append these to the end of the URL, preceded and separated by the `&` symbol:
`https://portal.bizcore.com.au/(apply:application-form)?apiKey=a56a731a-552b8-1491-fd6a-705817cecb&apiKeyId=e308c529-ciqq-3260-dfqx-971af977c605&formId=c198ce3c9-b598-b0eded9-be76e9f4033d&leadSource=SEO&campaign=June2020&leadMedium=email`
Now when users share the above link, or embed it using HTML or JavaScript, the information stored within the identifiers will be captured and passed into Biz Core. Check the Lead Record or Reporting sections below for more.
## **Customisable Identifiers**
Subscribers can also use customisable identifier parameters to store additional analytical information. This data cannot be used for filtering or sorting in Biz Core, it can only be displayed in the Reports workspace. These customisable identifiers are useful for passing and storing Google Click ID (GCLID) data into Biz Core or a specific custom identifier subscribers require.
When [sharing or embedding](https://bizcore.refined.site/space/BCKB/1776615437/Application+Form+Setup#Share-&-Embed-Application-Form) an Application Form, the URL linking to the application will be formatted as:
`https://portal.bizcore.com.au/(apply:application-form)?apiKey=a56a731a-552b8-1491-fd6a-705817cecb&apiKeyId=e308c529-ciqq-3260-dfqx-971af977c605&formId=c198ce3c9-b598-b0eded9-be76e9f4033d`
The same link will be contained in an ``
> ℹ️ The above URLs are for demonstration purposes only, subscribers should only use the specific [link or embed code](https://bizcore.refined.site/space/BCKB/1776615437/Application+Form+Setup#Share-&-Embed-Application-Form) generated within their Biz Core subscription.
Users can add custom identifiers to this URL, formatted using key-value pairs:
- `identifiers={"key1":"val1","key2":"val2"}`
Add the analytical information to pass to Biz Core in as key-value pairs, for example:
- `identifiers={"gclid":"cl2949325812093","utm_medium":"email"}`
Users can include as many key-value pairs they require. This is then appended to the end of the URL, preceded by the `&` symbol:
`https://portal.bizcore.com.au/(apply:application-form)?apiKey=a56a731a-552b8-1491-fd6a-705817cecb&apiKeyId=e308c529-ciqq-3260-dfqx-971af977c605&formId=c198ce3c9-b598-b0eded9-be76e9f4033d&identifiers={"gclid":"cl2949325812093","utm_medium":"email"}`
Both explicit and customisable identifiers can be included in a URL, for example:
`https://portal.bizcore.com.au/(apply:application-form)?apiKey=a56a731a-552b8-1491-fd6a-705817cecb&apiKeyId=e308c529-ciqq-3260-dfqx-971af977c605&formId=c198ce3c9-b598-b0eded9-be76e9f4033d&leadSource=SEO&campaign=June2020&leadMedium=email&identifiers={"gclid":"cl2949325812093","utm_medium":"email"}`
Before sharing a URL with customisable identifiers, check the **Encoding** section below.
# **Programmatically Adding URL Identifiers**
It is often necessary to add URL identifiers dynamically and in real-time, especially when the identifiers are received from different sources or need to be customised based on specific conditions. A method for passing these identifiers on-the-fly to Biz Core is to programmatically add them to the application form URL that is embedded on a webpage. Subscribers can utilise various scripting languages such as JavaScript, PHP, or consult with their web developer for assistance.
By using scripting languages, subscribers can manipulate the application form URL to incorporate the desired identifiers. Ensure that all identifiers added to the URL are properly encoded to maintain compatibility and functionality. Depending on the scripting language chosen, there are different methods and functions available to achieve URL encoding. Biz Core recommend consulting with a web developer or referring to the relevant documentation for the scripting language being used to implement the desired functionality effectively.
Remember, while the method of programmatically adding identifiers is different from achieving it manually, the principle is the same; encoding the identifiers correctly is crucial to ensure the overall integrity and proper functioning of the application form URL.
# **Encoding**
The best practice for sharing or embedding a URL with identifiers is to process the plain-text and key-value pairs into a URL-encoded format.
Some browsers may encode the link automatically, and certain website infrastructure is able to take the unencoded identifiers and run a script to encode them before rendering the embedded application form, however best practice is to ensure the process is completed before sharing with applicants.
## **Encoding Explicit Identifiers**
Take any plain-text that is intended to be included after the `=` on each of the in-built explicit identifiers and run it through a [URL Encoder/Decoder](https://meyerweb.com/eric/tools/dencoder/) tool. This example will use the campaign identifier:
- `winter 2023`
Enter the plain-text in the field and click **Encode**:
Typically only text that includes spaces or symbols will change after being encoded, however it is recommended that users run all text through an encoder to ensure it is correctly formatted.
After clicking **Encode**, copy the converted text and add it to the explicit identifier after the `=` symbol:
- `campaign=winter%202023`
This is then appended to the Application Form URL, preceded and separated by the `&` symbol:
`https://portal.bizcore.com.au/(apply:application-form)?apiKey=a56a731a-552b8-1491-fd6a-705817cecb&apiKeyId=e308c529-ciqq-3260-dfqx-971af977c605&formId=c198ce3c9-b598-b0eded9-be76e9f4033d&campaign=winter%202023`
## **Encoding Customisable Identifiers**
Take the entire set of key-value pairs intended to be included after `identifiers=` , including the curly braces `{ }` and run it through a [URL Encoder/Decoder](https://meyerweb.com/eric/tools/dencoder/) tool. This example will use the key-values:
- `{"gclid":"cl2949325812093","utm_medium":"email"}`
Copy the plain-text in the field and click **Encode**:
After clicking **Encode**, copy the converted text and add it after `identifiers=`:
- `identifiers=%7B%22gclid%22%3A%22cl2949325812093%22%2C%22utm_medium%22%3A%22email%22%7D`
This is then appended to the Application Form URL, preceded by the `&` symbol:
`https://portal.bizcore.com.au/(apply:application-form)?apiKey=a56a731a-552b8-1491-fd6a-705817cecb&apiKeyId=e308c529-ciqq-3260-dfqx-971af977c605&formId=c198ce3c9-b598-b0eded9-be76e9f4033d&identifiers=%7B%22gclid%22%3A%22cl2949325812093%22%2C%22utm_medium%22%3A%22email%22%7D`
## **Complete Encoded URL**
An example of a complete encoded URL with all three explicit and customisable identifiers would be formatted like the following:
`https://portal.bizcore.com.au/(apply:application-form)?apiKey=a56a731a-552b8-1491-fd6a-705817cecb&apiKeyId=e308c529-ciqq-3260-dfqx-971af977c605&formId=c198ce3c9-b598-b0eded9-be76e9f4033d&leadSource=direct%20marketing&campaign=winter%202023&leadMedium=email%20newsletter&identifiers=%7B%22gclid%22%3A%22cl2949325812093%22%2C%22utm_medium%22%3A%22email%22%7D`
This can now be [shared or embedded](https://bizcore.refined.site/space/BCKB/1776615437/Application+Form+Setup#Share-&-Embed-Application-Form) without relying on a browser or webpage architecture to encode appropriately.
# **Lead Record**
The explicit, in-built identifiers are attached to each Lead Record. Use the sidebar and navigate to **Workspaces → Leads**, then locate and open a Record. The Lead Summary will contain data about the Lead Source and Campaign:
This is also reflected in other Workspaces such as Application Summaries.
# **Reporting**
URL identifiers from Leads are also available to analyse in the Reports workspace. Use the sidebar and navigate to **Reports → Leads**, then either customise the date range the user wants to view data for, or leave the pre-filled dates to view all leads originating in the current month. Users can also utilise the dropdown boxes to filter leads based on the `leadSource=` and `campaign=` identifiers attached to the application form URL, as well as only searching for leads of specific loan products or lead statuses:
Click **SEARCH **to display lead results from the set criteria:
Use the **Group By **toggle to view the leads based on either their Source or Campaign:
Each group of leads will be contained in a row within the table of results, columns display information about the groups of leads, and allow users to sort the data by clicking the column heading. Each column heading is explained below:
| **Column Name** | **Description** |
| --- | --- |
| Source | This is the source data passed through the `leadSource=` identifier. Column is only visible when grouping by Source. |
| Campaign Name | This is the campaign data passed through the `campaign=` identifier. Column is only visible when grouping by Campaign. |
| Campaign Count | Indicates the total number of campaigns from which the leads in this source originate. Column is only visible when grouping by Source. |
| Total | Total number of leads in each group. |
| Incomplete | Percentage and number of leads that have an Incomplete status in each group. An Incomplete lead indicates an applicant has not completed the application form. |
| Complete | Percentage and number of leads that have a Complete status in each group. A Complete lead indicates an applicant has completed the application form. |
| Dismissed | Percentage and number of leads that have a Dismissed status in each group. A Dismissed lead indicates a user has dismissed the application. |
| Sold | Percentage and number of leads that have a Sold status in each group. |
| Converted | Percentage and number of leads that have a Converted status in each group. A Converted lead indicates a user has converted the lead to an application. |
| Loans | Percentage and number of leads in each group where the application has been approved as a loan. |
To view a list of leads contained in a group, click the **Show Leads** **⫶Ⲷ **icon attached to any of the Source or Campaign groups:
From here users can view information about each specific lead in the group, and sort by most of the columns. Each column heading is explained below:
| **Column Name** | **Description** |
| --- | --- |
| Name | This is the name of the applicant. |
| Source | This is the source data passed through the `leadSource=` identifier. |
| Medium | This is the medium data passed through the `leadMedium=` identifier. |
| Campaign | This is the campaign data passed through the `campaign=` identifier. |
| Received | This is the date the lead was received. |
| Lead Status | This is the current status of the lead. |
| Application Status | This is the current status of the application, if the lead was converted. |
| Loan Status | This is the current status of the loan, if the application was approved. |
| Hookup/Topup | This displays whether the lead is a hookup; a brand new loan for a first time customer, or a topup; the lead is for an applicant who already has at least one existing loan. |
| ID(s) | This is where the information passed in through the `identifiers={"key1":"val1","key2":"val2"}` key-value pairs is displayed. The data is visible within the reports workspace, it cannot be used to filter or sort the lead data. |
## **Export Identifiers**
Users can export all lead data from their search results as a .CSV by clicking the **Download **⬇️ button in the table header, or download specific data for each group by clicking the **Download **⬇️ button attached to any of the rows:
Within the .CSV file, the data passed through the identifiers is stored against each lead:
| **Column Name** | **Description** |
| --- | --- |
| LeadSourceName | This is the source data passed through the `leadSource=` identifier. |
| LeadMedium | This is the medium data passed through the `leadMedium=` identifier. |
| LeadCampaign | This is the campaign data passed through the `campaign=` identifier. |
| LeadIdentifiers | This is the customisable identifier information passed through the `identifiers={"key1":"val1","key2":"val2"}` key-value pairs. |