Overview of Dataflows & Integrations using Retreaver

Introduction to the Retreaver API

Retreaver provides an API interface that developers can utilize to perform certain actions typically only accessible from within the Retreaver platform such as:

• Creating & configuring campaigns
• Creating & configuring endpoints
• Creating & configuring numbers
• Accessing recent calls

You can view the Retreaver API documentation for more information:
https://retreaver.github.io/core-api-docs/#introduction

The Retreaver API can perform almost all the actions available inside of our platform, which provides a solid interface for users who wish to programmatically manage their Retreaver campaigns.

The main purpose of the API is to provide an interface for users who wish to manage their campaigns programmatically based on events that occur outside of the Retreaver platform.

While this functionality is very powerful, We recommended sticking with the Retreaver platform unless you absolutely require the ability to access or modify your Retreaver campaigns outside of the platform. A majority of your call tracking tasks such as creating and configuring campaigns, endpoints or numbers should be handled inside of the platform for a simple and hassle free experience.

Accessing your Calls via API

If you wish to access your call information programmatically for the purpose of building a custom integration, refer to our "Get Recent Calls" section of the documentation.

Authenticating into the Retreaver API

You will need to supply an API Key and the company ID of your account in order to make valid requests using the Retreaver API.

• Your API key will be accessible under the "Settings -> My Account -> API Access" subsection.
• Your Company Id will be accessible under the "Settings -> My Company" subsection.

Integrating Retreaver into your Web Content using Retreaver.js

Retreaver provides a configurable script that can be placed on your web content in order to better manage and control tracking numbers placed on your pages.

The Retreaver.js script enables various features for tech-savvy affiliate marketers:

1. Enabling dynamic number insertion.
2. Displaying keyword or source specific tracking numbers.
3. Storing browser session or event details as tags to incoming calls.
4. Enabling Real-Time Page Tracking for your web content.
5. Triggering calls on button press using Click-To-Call.

View our Retreaver.js guide article to learn more: "How To Use Retreaver.Js"

Integrating with Third-Party Platforms

Retreaver provides several articles and guides that can help you integrate with third party platforms across the web. Access our Integrations subsection to view the various integration guides. 

If the platform you are integrating with is reasonably popular, odds are they are supported on the Zapier platform. The Zapier platform provides a middle man interface between Retreaver campaign webhooks which can then be used to trigger actions or scripts for your desired third party application.

View our Zapier article to learn more:
Benefits Of Using Zapier To Connect All Of Your Web-Services

View our "Zapier integration" guide for a Google Sheet use case demonstration using webhook campaigns.

Inbound data flow using Retreaver

Retreaver provides several methods for sending lead data into the platform, any received data can then be used to influence routing decisions, trigger events or pass along valuable information to call agents on the other line.

The following Retreaver methods support inbound data flows:

1. Static Number Tagging
2. Programmatically using Real-Time Page Tracking
3. Campaign IVR prompts
4. Click-to-Call initiations
5. Publisher Data Posting Link
6. Webhook Integrations

You may review the various inbound data methods using our "How to Add Data to Calls" reference guide: "How to Add Data to Calls"

Outbound data flow using Retreaver

Retreaver provides several methods for forwarding call data into your desired third party platforms. Forwarded data can be utilized to generate custom call analytics and reports, or used to trigger events outside of the Retreaver platform.

Option A) Webhooks:

The simplest and most effective way to forward call data out to a third party platform would be achieved through using Retreaver webhooks. Retreaver webhooks can be configured to automatically trigger at the start, middle or end of a call. Webhooks can automatically send out call attributes into an HTTP endpoint capable of receiving and processing URL parameters.

If you can provide an HTTP endpoint capable of processing incoming parameters, you will be able to send all of your desired call attributes in any format you require.

Any attributes sent out via webhooks will be forwarded using a standard string/text data type, you may then cast and convert to any desired data type if required once the data is processed by your system.

You may review outbound data webhooks using our reference material here:
Retreaver Campaign Webhooks

Option B) API Request:

Another method of forwarding outbound call data can be achieved through our API's "Get Recent Calls" functionality.

You may view the API documentation for our "Get Recent Calls" functionality here:
https://retreaver.github.io/core-api-docs/#get-recent- calls

Your developers will have to send an HTTP GET request using the Retreaver API in order to fetch a list of recent calls by inputting parameters that specify which campaign and time range they wish to pull calls from. Your developers can then parse the JSON response in order to retrieve any desired call attributes.

The primary purpose of our "Get Recent Calls" feature is to allow developers the ability to access Retreaver call data programmatically from specific campaigns and time ranges for use on custom built applications.

Using the API requires a technical background in order to setup, we recommend sticking with a webhook solution unless you intend to build a custom application using Retreaver call data.