No-code analytics for end-customers
In this guide, you will learn how to embed a link to a no-code analytics page in order for you customers to:
- View shipment emissions analytics
- Explore emission estimates for their shipments
- Understand how individual estimates were calculated.
- Create Client Accounts with handles
- Calculate emission estimates through Client Accounts
- Mark emission estimates as shipments
Create Client Accounts with handles
In order for your customers to have their own analytics and individual emission estimates pages, you are required to create a Client Account for each customer. Client Accounts can be created via API or Logistics CSV spreadsheet.
For Client Account details follow this link.
When creating a Client Account provide a
The handle must be unique per organisation and can only contain lowercase alphanumeric characters, underscore and dashes.
Note: you may re-use the same handle in live mode and test mode.
The handle is defined by clients to uniquely identify their customers.
It is URL friendly, therefore it can be included in links.
Calculate emission estimates through Client Accounts
Emission estimates must be performed with a specific Client Account.
To act as a Client Account
Mark emission estimates as shipment
Emission estimates are not always performed for shipments. For instance, you may perform estimates during the booking flow.
In order for the analytics page to display analytics for shipments, emission estimates must be marked as shipments, by setting the
Client Account analytics URL
Each of your customer is representated by a distinct Client Account and therefore gets its own analytics and individual emission estimates pages.
handle was define by you, you are able to construct the URL for your customer's analytics page.
The URL is as follows:
<ORG_ID>is your organisation id. This value does not change. Your id can be copied from your settings page.
<HANDLE>is the handle defined by you.
Note: for test Client Accounts use the following url:
Embed the URL in your app
Once you've constructed the URL, you can embed it in a link or button within your app. We recommend opening a new tab or window.
This enables your customers to:
- view emissions analytics
- explore emission estimates for their shipments
- understand how individual estimates were calculated.