Global DNI Tag Management

Using Global DNI Tags, multiple Groups can share the same JavaScript snippet.

The following key benefits can be achieved using Global DNI Tags:

  • Share the same JavaScript snippet while still allowing granular reporting access in the UI

  • Integrations can differ across Number Groups based on customer need. By allowing the same DNI Tag to support multiple Number Groups, integration settings can be individually customized

  • Number Group management is simplified to allow more flexibility in Number and Number pool assignment - alleviating the need for all Numbers and Number pools to belong to the same Number Group

  • The same Global DNI Snippet is capable of simultaneously supporting channel-based and keyword/campaign attribution cases

Please note that to use your Global DNI snippet you must assign it when creating your Number Group. For Additional details refer to Keyword/Campaign Attribution and Channel Attribution

Outlined below are the methods that can be used to manage Global DNI Tags.

Creating Global DNI Tags

Using this number assignment method, you may use the following endpoint to create your number:

To create a Global DNI snippet, use the following endpoint:

POST https://api.telmetrics.com/v3/api/globalsnippets

{
    "name": "ABC Company",
    "description": "Global DNI Snippet for all franchises",
    "delayed_attribution_period": 7
}

Sample Response:

{
    "id": "451049c3-c0f1-49bf-5756-08d8c2dbe75c",
    "name": "ABC Company",
    "description": "Global DNI Snippet for all franchises",
    "JSsnippet": "<script type=\"text/javascript\" src=\"//js.LabR.web-2-tel.com/org-sdk?identifier=4541049c3-c0f1-49bf-5756-08d8c2dbe75c\" async></script>",
    "status": "active",
    "delayed_attribution_period": 7
}

For field definitions please refer to the 'Field Definitions' section at the bottom of this page.

Retrieving Global DNI Snippets

Use the following API end-points to retrieve Global DNI Snippets:

Sample Request:
GET https://api.telmetrics.com/v3/api/globalsnippets

Sample Response:

{
    "paging": {
        "pageNumber": 1,
        "pageSize": 100,
        "total": 2
    },
    "results": [
        {
            "id": "237e7eb9-eea1-45f8-6ded-08d8c2dd6105",
            "name": "ABC Company",
            "description": "Global DNI Snippet for all franchises",
            "JSsnippet": "<script type=\"text/javascript\" src=\"//js.LabR.web-2-tel.com/org-sdk?identifier=237e7eb9-eea1-45f8-6ded-08d8c2dd6105\" async></script>",
            "active": true,
            "delayed_attribution_period": 7
        },
        {
            "id": "a9e684a7-ef00-4021-bb2a-efed741c7c69",
            "name": "ABC Motors Inc",
            "description": "Global DNI Snippet for all ABC Motor Locations",
            "JSsnippet": "<script type=\"text/javascript\" src=\"//js.LabR.web-2-tel.com/org-sdk?identifier=a9e684a7-ef00-4021-bb2a-efed741c7c69\" async></script>",
            "active": true,
            "delayed_attribution_period": 30
        }
    ]
}

Update Global Snippet

Updates to a Global Snippet may be made by submitting request to the following API endpoint:

Sample Request

{
    "id": "237e7eb9-eea1-45f8-6ded-08d8c2dd6105",
    "name": "ABC Company",
    "description": "Global DNI Snippet for all franchises",
    "JSsnippet": "<script type=\"text/javascript\" src=\"//js.LabR.web-2-tel.com/org-sdk?identifier=237e7eb9-eea1-45f8-6ded-08d8c2dd6105\" async></script>",
    "active": true,
    "delayed_attribution_period": 15
}

Sample Response:

{
    "id": "237e7eb9-eea1-45f8-6ded-08d8c2dd6105",
    "name": "ABC Company",
    "description": "Global DNI Snippet for all franchises",
    "JSsnippet": "<script type=\"text/javascript\" src=\"//js.LabR.web-2-tel.com/org-sdk?identifier=237e7eb9-eea1-45f8-6ded-08d8c2dd6105\" async></script>",
    "active": true,
    "delayed_attribution_period": 15
}

Field Definitions

Field

Value

id

unique identifier for the Global DNI Tag

name

unique name for the the tag that will be visible in the UI when configuring Groups.

description

description of the tag

JSsnippet

Global DNI Tag JavaScript snippet that is to be deployed onto websites where attribution data is to be collected

status

current status of the tag. Possible values 'active', 'inactive'.

Note that Global DNI tags cannot be deactivated while Groups are associated with the tag.

delayed_attribution_period

An attribution period (in days) that defines how long to continue to associate new site visits and repeat callers to their DNI session