telmetricsV3

Telmetrics V3 API Developer Documentation

Welcome to the Telmetrics V3 developer hub. You'll find comprehensive guides and documentation to help you start working with our API as quickly as possible.

Get Started    

DoubleClick Search

The DoubleClick Search integration is managed at the Group level. When enabled, all calls made to Number and NumberPools will be uploaded to DoubleClick Search into a Floodlight Activity. For more details on how to configure a Floodlight Activity for calls and texts, please visit https://learn.telmetrics.com.

To configure DoubleClick Search for your Group, you will need to:

  • Authorize Telmetrics to post offline conversions via the DoubleClick Search API
  • Configure the DoubleClick Search integration for your Group

1. DoubleClick Search Authentication

Before posting Floodlight Activities to DoubleClick Search, you will need to Authorize Telmetrics to post to DoubleClick via API. This configuration is completed via the Telmetrics Ordering Portal.

Log in to the Telmetrics Ordering Portal as an administrator user, and navigate to the 'Settings' menu. From the menu, select the 'Integrations' option:

From the 'Integrations' screen, connect 'DoubleClick Search'

This will open a modal that will allow you to authorize Telmetrics to post to Floodlight Activities via API:

All integration authentications that are configured via the Telmetrics Ordering Portal can be retrieved via the following end-point:

GET https://api.telmetrics.com/v3/api/configurations/integrations

The resulting output will look something like:

[
    {
        "integration_auth_id": "da62a35b-b9af-4916-bbdc-bdbbecd59b04",
        "description": "ABC Company - AdWords Integration",
        "type": "AdWords",
        "created_datetime": "2018-05-14T12:53:40.307"
    },
    {
        "integration_auth_id": "E10D7FF2-B2F2-4C9F-81D1-3CACAF4FCEFC",
        "description": "ABC Company - DoubleClickSearch Integration",
        "type": "DoubleClickSearch",
        "created_datetime": "2018-04-07T12:53:40.307"
    }
 ]

The 'integration-auth_id' returned above, will be a required field when configuring an integration for your Group.

2. Configuring your DoubleClick Search Integration

Your DoubleClick Search configuration is associated with a Group. Below are the fields used when configuring this integration:

Field
Description
Required
Possible Values

type

The type of Integration you want to create

Yes

DoubleClickSearch

integration_auth_id

Unique id created when you authorize Telmetrics to post conversion on your behalf (see Integration Authentication for more details)

Yes

GUID

configuration -> custom_floodlight_name

DoubleClick Search Floodlight Activity Name

No

An existing DoubleClick Search Floodlight Activity. If not supplied, the Floodlight Activity named "Telmetrics Calls" will be used

configuration -> minimum_call_duration

Minimum call duration (in seconds) that must be exceed before posting to the configured Floodlight activity

No

Integer

Below is an example of how to configure a DoubleClick Search Integration using the criteria outlined above:
POST https://api.telmetrics.com/v3/api/groups/{group_id}/integrations

Remember when configuring an Integration, it must be assigned to a group.

{  
  "type": "DoubleClickSearch",
  "integration_auth_id": "E10D7FF2-B2F2-4C9F-81D1-3CACAF4FCEFC",
  "configuration": {
    "custom_floodlight_name": "Search Campaign - phonecalls",
    "minimum_call_duration": 5
  }
}

This request will result in a response similar to the following:

{
    "type": "DoubleClickSearch",
    "integration_id": "d889faef-b6cb-4daa-afab-f767673057b1",
    "integration_auth_id": "E10D7FF2-B2F2-4C9F-81D1-3CACAF4FCEFC",
    "group_id": 11623348,
    "created_datetime": "2018-05-14T17:05:09.7261789Z",
    "modified_datetime": "2018-05-14T17:05:09.7261789Z",
    "configuration": {
      "custom_floodlight_name": "Search Campaign - phonecalls",
      "minimum_call_duration": 5
    }
}

Note that the 'integration_id' returned by this request must be used for any subsequent updates.

3. Updating your DoubleClick Search Integration

In the event that you need to update your DoubleClick Search Integration, you will need to submit your request to the following end-point:

POST {{webserviceurl}}/v3/api/groups/integrations/{integration_id}

{  
  "integration_auth_id": "d889faef-b6cb-4daa-afab-f767673057b1",
  "configuration": {
      "custom_floodlight_name": "Search Campaign - phonecalls",
      "minimum_call_duration": 20
  }
}

This request will result in a response similar to the following:

{
    "type": "DoubleClickSearch",
    "integration_id": "d889faef-b6cb-4daa-afab-f767673057b1",
  	"integration_auth_id": "d889faef-b6cb-4daa-afab-f767673057b1",
    "group_id": 11623348,
    "created_datetime": "2018-05-14T17:05:09.727",
    "modified_datetime": "2018-05-14T17:19:43.9688953Z",
    "configuration": {
      "custom_floodlight_name": "Search Campaign - phonecalls",
      "minimum_call_duration": 20
    }
}

DoubleClick Search


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.