Introduction

Doc Version: 2.1.2

Welcome to fullthrottle.ai's AudienceFlume API. Whether you’re an API pro, a beginning developer or an agency and media reseller, our API catalog is waiting for your imagination. The AudienceFlume API enables partners to access their transformed first party household data identified, collected, and resolved across devices on the fullthrottle.ai platform. Come on in to explore your data, browse descriptions of the available attributes and see examples of working requests and responses.

4 EASY STEPS to Go LIVE

STEP
1	CREDENTIALS - Get your API Credentials & Endpoint from your FT Onboarding Manager
2	AUTHENTICATE - Authenticate your API session with credentials
3	REQUEST DATA - Test your Queries against the Endpoint to prove
4	GO LIVE - Confirm Go LIVE with your Onboarding Team and switch to Live Credentials & Live Endpoint

STEP 1. CREDENTIALS

Once your agreement and paperwork is completed, you need an API key and 3 other key attributes to begin using our APIs. These details are available from your fullthrottle.ai Onboarding Manager. Once you’ve received your keys and endpoints, you’re ready to roll.

Partner Data Keys

Field	Description
APP_ID	Application ID
API_KEY	Unique Application Access Key
CHANNEL_ID	Channel ID specific to the Partner Channel
ENDPOINT_URL	The url of the target AudienceFlume endpoint (e.g. https://xyz.com)

Once you have these four data fields, you are ready to progress to the Authentication step.

STEP 2. AUTHENTICATE

In the panel on the right we share how to authenticate via

Shell Command

PHP

curl -u "{{APP_ID}}:{{API_KEY}}" \
--header "Content-Type: application/json" \
"ENDPOINT_URL/clients?channel={{CHANNEL_ID}}"

<?php

$app_id = 'APP_ID'; // Replace value with your APP ID credential

$api_key = 'API_KEY'; // Replace value with your API KEY credential

$authorization = 'Basic '.base64_encode( $app_id.':'.$api_key);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type:application/json', 'Authorization:'.$authorization));

OR 

//php standard way
curl_setopt($ch, CURLOPT_USERPWD, $app_id.':'.$api_key);


?>

NOTE for other languages you can use similar. e.q. 

Send in the HTTP header 

Content-Type:application/json

Authorization: basic {AUTH_STRING_HERE}

where AUTH_STRING_HERE = base64_encode( {APP_ID}:{API_KEY});

Please review the relevant panel to Authenticate using your chosen method.

STEP 3. REQUEST DATA

Having completed Authentication (Step 2), you are now ready to move on to testing Data Requests via our API.

CLIENT LIST - The first step in accessing your partner Household Data is to use the Channel ID to get the list of clients under your partner channel. Each client has a unique Client ID which you then use with the relevant Households query to extract the households under that client

CAMPAIGNS LIST - Extract a list of Campaigns which a specific Client ID was running in a specific period. Period specified by month and year.

HOUSEHOLDS List - Extract a list of Households for a specific Client ID. List can be filtered by Campaign ID, Date, Month and year, and Radius. There are also pagination options and max record limit options.

INFLUENCE HOUSEHOLDS List - Extract a list of Households for a specific Client ID. List can be filtered by Campaign ID, Date, Month and year, and Radius as well as Make/Model and influence tags. There are also pagination options and max record limit options.

Reference - Codes and references

Clients List

GET

curl -u "{{APP_ID}}:{{API_KEY}}" \
--header "Content-Type: application/json" \
"ENPOINT_URL/clients?channel={{CHANNEL ID}}"

<?php

$app_id = "{{APP_ID}}";
$api_key = "{{API_KEY}}";

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => '[ENDPOINT URL HERE]/clients?channel={{CHANNEL ID}}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_USERPWD => $app_id.':'.$api_key,
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
?>

{
    "response": {
        "channels": [
            {
                "channel": "99",
                "channel_name": "Acme Co",
                "clientid": "990782",
                "client_name": "Downtown Acme"
            },
            {
                "channel": "99",
                "channel_name": "Acme Co",
                "clientid": "980780",
                "client_name": "Suburban Acme"
            },
            {
                "channel": "99",
                "channel_name": "Acme Co",
                "clientid": "970988",
                "client_name": "Metro Acme"
            }
        ]
    }
}

Description: The first step in accessing your partner Household Data is to use the Channel ID to get the list of Clients under your Partner Channel. Each Client has a unique Client ID which you then use with the relevant Households query to extract the households under that client.

HTTP Request

***GET*** /clients Parameters

Name	Located in	Description	Required	Type	Format	Example
channel	query	CHANNEL_ID from FT Account director	Yes	integer	digits	43
Authorization	header		Yes	string

Responses

Code	Description
200	200 response

Campaigns List

GET

Description: Extract a list of Campaigns which a specific Client ID was running in a specific period. Period specified by month and year.

HTTP Request

***GET*** /campaigns

curl -u "{{APP_ID}}:{{API_KEY}}" \
--header "Content-Type: application/json" \
"ENPOINT_URL/campaigns?clientid={{CLIENTID}}&month={{MONTH}}&year={{YEAR}}"

<?php

$app_id = "{{APP_ID}}";
$api_key = "{{API_KEY}}";

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'ENPOINT_URL/campaigns?clientid={{CLIENTID}}&month={{MONTH}}&year={{YEAR}}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_USERPWD => $app_id.':'.$api_key,
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

?>

{
    "response": {
        "campaigns": [{
                "clientid": "990782",
                "channel": "99",
                "client_name": "Downtown Acme",
                "client_status": "active",
                "campaignid": "98716",
                "campaign_name": "Primary",
                "campaign_status": "active"
            },
            {
                "clientid": "980780",
                "channel": "99",
                "client_name": "Suburban Acme",
                "client_status": "active",
                "campaignid": "98715",
                "campaign_name": "Out of Market",
                "campaign_status": "inactive"
            }
        ],
        "channels": [{
            "channel": "99",
            "name": "Acme Co"
        }]
    }
}

Parameters

Name	Located in	Description	Required	Type	Format	Example
year	query	Year	No	integer	4 digit	2022
month	query	Month	No	integer	2 digit	01
clientid	query		Yes	integer	0-9	360815
Authorization	header	ClientID from the clients list query	Yes	string

Responses

Code	Description
200	200 response

Households List

GET

curl -u "{{APP_ID}}:{{API_KEY}}" \
--header "Content-Type: application/json" \
"ENPOINT_URL/households?clientid={{CLIENTID}}&from={{DATE-FROM}}&till={{DATE-TO}}&radius={{RADIUS}}&channel={{CHANNEL_ID}}&page=1&rows_limit=1000"

<?php

$app_id = "{{APP_ID}}";
$api_key = "{{API_KEY}}";

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'ENPOINT_URL/households?clientid={{CLIENTID}}&from={{DATE-FROM}}&till={{DATE-TILL}}&radius={{RADIUS}}&channel={{CHANNEL_ID}}&page=1&rows_limit=1000',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_USERPWD => $app_id.':'.$api_key,
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

?>

{
    "response": {
        "page": 1,
        "rows_limit": 10,
        "radius": 5000,
        "count": "459",
        "next": "https://your-endpoint_url.com/households?clientid=990782&from=2022-01-01&till=2022-01-07&channel=99&campaignid=&radius=&page=2&query=households&rows_limit=10",
        "households": [{
                "addressid": "99145446",
                "campaignid": "98716",
                "address_full": "9611 Sundale Jones St, Highlands Ranch CO 80129-6269",
                "address_first_line": "9611 Sundale Jones St",
                "address_second_line": "",
                "address_last_line": "Highlands Ranch CO 80129-6269",
                "city": "Highlands Ranch",
                "state": "CO",
                "zip": "80129",
                "plus4code": "6269",
                "streetname": "Sundale Jones",
                "client_distance": "5.548422149111",
                "devices": [
                    "iPhone"
                ],
                "make_models": [{
                    "year": null,
                    "make": "Chevrolet",
                    "model": "Suburban"
                }]
            },
            {
                "addressid": "99221583",
                "campaignid": "98716",
                "address_full": "4714 James Brown St, Aurora CO 80015-2111",
                "address_first_line": "4714 James Brown St",
                "address_second_line": "",
                "address_last_line": "Aurora CO 80015-2111",
                "city": "Aurora",
                "state": "CO",
                "zip": "80015",
                "plus4code": "2111",
                "streetname": "James Brown",
                "client_distance": "9.334573865105",
                "devices": [
                    "iPhone"
                ],
                "make_models": [{
                    "year": "2021",
                    "make": "Chevrolet",
                    "model": "Suburban"
                }]
            },
            {
                "addressid": "99425807",
                "campaignid": "98715",
                "address_full": "132 Northants Ave, Oak Bluffs MA 02557-7144",
                "address_first_line": "132 Northants Ave",
                "address_second_line": "",
                "address_last_line": "Oak Bluffs MA 02557-7144",
                "city": "Oak Bluffs",
                "state": "MA",
                "zip": "2557 ",
                "plus4code": "7144",
                "streetname": "Northants Ave",
                "client_distance": "1799.036746121",
                "devices": [
                    "iPhone"
                ],
                "make_models": []
            }
        ]
    }
}

Description: Extract a list of Households for a specific Client ID. List can be filtered by Campaign ID, Date, Month and Year, and Radius. There are also pagination options and max record limit options.

HTTP Request

***GET*** /households

Parameters

Name	Located in	Description	Required	Type	Format	Example
clientid	query	ClientID from the clients list query	Yes	integer	digits only	360815
channel	query	CHANNEL_ID from FT Account director	No	integer	digits only	43
from	query	Date from	Yes/No	string	YYYY-mm-dd	2022-01-31
till	query	Date to	Yes/No	string	YYYY-mm-dd	2022-01-01
month	query	Month	Yes/No	integer	2 digit	01
year	query	Year	Yes/No	integer	4 digit	2022
radius	query	Radius from the dealer in miles	No	integer	1-5000	50
page	query	Page	No	integer	1 - maxpage	1
rows_limit	query	Max rows to return in the response	No	integer	10 - 1000	1000
Authorization	header		Yes	string

Note : you can use or from/till dates OR month/year , one of these sets is required

Note : to get next 1000 ( or rows_limit ) households you can use {{nextlink}} from the response

Responses

Code	Description
200	200 response

MultiUnits

GET

curl -u "{{APP_ID}}:{{API_KEY}}" \
--header "Content-Type: application/json" \
"ENPOINT_URL/multiunits?clientid={{CLIENTID}}&from={{DATE-FROM}}&till={{DATE-TILL}}&radius={{RADIUS}}&channel={{CHANNEL_ID}}&page=1&rows_limit=1000"

<?php

$app_id = "{{APP_ID}}";
$api_key = "{{API_KEY}}";

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'ENPOINT_URL/multiunits?clientid={{CLIENTID}}&from={{DATE-FROM}}&till={{DATE-TILL}}&radius={{RADIUS}}&channel={{CHANNEL_ID}}&page=1&rows_limit=1000',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_USERPWD => $app_id.':'.$api_key,
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

?>

{
    "response": {
        "page": 1,
        "rows_limit": 10,
        "radius": 5000,
        "count": "459",
        "next": "https://your-endpoint_url.com/multiunits?clientid=990782&from=2022-01-01&till=2022-01-07&channel=99&campaignid=&radius=&page=2&query=households&rows_limit=10",
        "households": [{
                "addressid": "99145446",
                "campaignid": "98716",
                "address_full": "9611 Sundale Jones St, Highlands Ranch CO 80129-6269",
                "address_first_line": "9611 Sundale Jones St",
                "address_second_line": "",
                "address_last_line": "Highlands Ranch CO 80129-6269",
                "city": "Highlands Ranch",
                "state": "CO",
                "zip": "80129",
                "plus4code": "6269",
                "streetname": "Sundale Jones",
                "client_distance": "5.548422149111",
                "devices": [
                    "iPhone"
                ],
                "make_models": [{
                    "year": null,
                    "make": "Chevrolet",
                    "model": "Suburban"
                }], 
                                "density": "3"
            },
            {
                "addressid": "99221583",
                "campaignid": "98716",
                "address_full": "4714 James Brown St, Aurora CO 80015-2111",
                "address_first_line": "4714 James Brown St",
                "address_second_line": "",
                "address_last_line": "Aurora CO 80015-2111",
                "city": "Aurora",
                "state": "CO",
                "zip": "80015",
                "plus4code": "2111",
                "streetname": "James Brown",
                "client_distance": "9.334573865105",
                "devices": [
                    "iPhone"
                ],
                "make_models": [{
                    "year": "2021",
                    "make": "Chevrolet",
                    "model": "Suburban"
                }],
                                "density": "5"
            },
            {
                "addressid": "99425807",
                "campaignid": "98715",
                "address_full": "132 Northants Ave, Oak Bluffs MA 02557-7144",
                "address_first_line": "132 Northants Ave",
                "address_second_line": "",
                "address_last_line": "Oak Bluffs MA 02557-7144",
                "city": "Oak Bluffs",
                "state": "MA",
                "zip": "2557 ",
                "plus4code": "7144",
                "streetname": "Northants Ave",
                "client_distance": "1799.036746121",
                "devices": [
                    "iPhone"
                ],
                "make_models": [], 
                                "density": "7"
            }
        ]
    }
}

Description: Extract a list of MultiUnit Residences for a specific Client ID. List can be filtered by Campaign ID, date, month and year, and radius. There are also pagination options and max record limit options.

HTTP Request

***GET*** /multiunits

Parameters

Name	Located in	Description	Required	Type	Format	Example
clientid	query	ClientID from the clients list query	Yes	integer	digits only	360815
channel	query	CHANNEL_ID from FT Account director	No	integer	digits only	43
from	query	Date from	Yes/No	string	YYYY-mm-dd	2022-01-31
till	query	Date to	Yes/No	string	YYYY-mm-dd	2022-01-01
month	query	Month	Yes/No	integer	2 digit	01
year	query	Year	Yes/No	integer	4 digit	2022
radius	query	Radius from the dealer in miles	No	integer	1-5000	50
page	query	Page	No	integer	1 - maxpage	1
rows_limit	query	Max rows to return in the response	No	integer	10 - 1000	1000
Authorization	header		Yes	string

Note : you can use or from/till dates OR month/year , one of these sets is required

Note : to get next 1000 ( or rows_limit ) households you can use {{nextlink}} from the response

Responses

Code	Description
200	200 response

Propensity Households List

GET

curl -u "{{APP_ID}}:{{API_KEY}}" \
--header "Content-Type: application/json" \
"ENPOINT_URL/propensity?clientid={{CLIENTID}}&from={{DATE-FROM}}&till={{DATE-TO}}&radius={{RADIUS}}&channel={{CHANNEL_ID}}&page=1&rows_limit=1000&model={MODEL}&tag={Influence tag}&ids={ids}&multiunits={Y/N/empty}"

<?php

$app_id = "{{APP_ID}}";
$api_key = "{{API_KEY}}";

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'ENPOINT_URL/propensity?clientid={{CLIENTID}}&from={{DATE-FROM}}&till={{DATE-TILL}}&radius={{RADIUS}}&channel={{CHANNEL_ID}}&page=1&rows_limit=1000&model={MODEL}&tag={Influence tag}&ids={ids}&multiunits={Y/N/empty}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_USERPWD => $app_id.':'.$api_key,
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

?>

{
    "response": {
        "page": 1,
        "rows_limit": 10,
        "radius": 5000,
        "count": "459",
        "next": "https://your-endpoint_url.com/propensity?clientid=990782&from=2022-01-01&till=2022-01-07&channel=99&campaignid=&radius=&page=2&query=households&rows_limit=10",
        "households": [{
                "addressid": "99145446",
                "campaignid": "98716",
                "address_full": "9611 Sundale Jones St, Highlands Ranch CO 80129-6269",
                "address_first_line": "9611 Sundale Jones St",
                "address_second_line": "",
                "address_last_line": "Highlands Ranch CO 80129-6269",
                "city": "Highlands Ranch",
                "state": "CO",
                "zip": "80129",
                "plus4code": "6269",
                "streetname": "Sundale Jones",
                "client_distance": "5.548422149111",
                "devices": [
                    "iPhone"
                ],
                "make_models": [{
                    "year": null,
                    "make": "Chevrolet",
                    "model": "Suburban"
                }],
        "propensity": {
                    "rscore_count": "40",
                    "rscore_description": "Residents In-Market Considering Purchase."
                }
            },
            {
                "addressid": "99221583",
                "campaignid": "98716",
                "address_full": "4714 James Brown St, Aurora CO 80015-2111",
                "address_first_line": "4714 James Brown St",
                "address_second_line": "",
                "address_last_line": "Aurora CO 80015-2111",
                "city": "Aurora",
                "state": "CO",
                "zip": "80015",
                "plus4code": "2111",
                "streetname": "James Brown",
                "client_distance": "9.334573865105",
                "devices": [
                    "iPhone"
                ],
                "make_models": [{
                    "year": "2021",
                    "make": "Chevrolet",
                    "model": "Suburban"
                }],
        "propensity": {
                    "rscore_count": "40",
                    "rscore_description": "Residents In-Market Considering Purchase."
                }

            },
            {
                "addressid": "99425807",
                "campaignid": "98715",
                "address_full": "132 Northants Ave, Oak Bluffs MA 02557-7144",
                "address_first_line": "132 Northants Ave",
                "address_second_line": "",
                "address_last_line": "Oak Bluffs MA 02557-7144",
                "city": "Oak Bluffs",
                "state": "MA",
                "zip": "2557 ",
                "plus4code": "7144",
                "streetname": "Northants Ave",
                "client_distance": "1799.036746121",
                "devices": [
                    "iPhone"
                ],
                "make_models": [],
                "propensity": {
                    "rscore_count": "40",
                    "rscore_description": "Residents In-Market Considering Purchase."
                }
            }
        ]
    }
}

HTTP Request

***GET*** /propensity

Description: Extract a list of Propensity for a specific Client ID, Household IDs. List can be filtered by Campaign ID, Date, Month and Year, and Radius. There are also pagination options and max record limit options.

Parameters

Name	Located in	Description	Required	Type	Format	Example
clientid	query	ClientID from the clients list query	Yes	integer	digits only	360815
channel	query	CHANNEL_ID from FT Account director	No	integer	digits only	43
from	query	Date from	Yes/No	string	YYYY-mm-dd	2022-01-31
till	query	Date to	Yes/No	string	YYYY-mm-dd	2022-01-01
month	query	Month	Yes/No	integer	2 digit	01
year	query	Year	Yes/No	integer	4 digit	2022
radius	query	Radius from the dealer in miles	No	integer	1-5000	50
page	query	Page	No	integer	1 - maxpage	1
rows_limit	query	Max rows to return in the response	No	integer	10 - 1000	1000
multiunits	query	Include Multiunits	No	char	Y/N/{empty}	Y
model	query	Make/Model filtering	No	text	{Make},{Model} or {Make}	Ram,1500 or Ram
ids	query	Households IDS	No	comma separeted integers	{int},{int},...	122244,4577889,222222
Authorization	header		Yes	string

Note : you can use or from/till dates OR month/year , one of these sets is required

Note : to get next 1000 ( or rows_limit ) households propensities you can use {{nextlink}} from the response

Responses

Code	Description
200	200 response

INFLUENCE Households List

GET

curl -u "{{APP_ID}}:{{API_KEY}}" \
--header "Content-Type: application/json" \
"ENPOINT_URL/influence?clientid={{CLIENTID}}&from={{DATE-FROM}}&till={{DATE-TO}}&radius={{RADIUS}}&channel={{CHANNEL_ID}}&page=1&rows_limit=1000&model={MODEL}&tag={Influence tag}&ids={ids}&multiunits={Y/N/empty}"

<?php

$app_id = "{{APP_ID}}";
$api_key = "{{API_KEY}}";

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'ENPOINT_URL/influence?clientid={{CLIENTID}}&from={{DATE-FROM}}&till={{DATE-TILL}}&radius={{RADIUS}}&channel={{CHANNEL_ID}}&page=1&rows_limit=1000&model={MODEL}&tag={Influence tag}&ids={ids}&multiunits={Y/N/empty}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_USERPWD => $app_id.':'.$api_key,
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

?>

{
    "response": {
        "page": 1,
        "rows_limit": 10,
        "radius": 5000,
        "count": "459",
        "next": "https://your-endpoint_url.com/influence?clientid=990782&from=2022-01-01&till=2022-01-07&channel=99&campaignid=&radius=&page=2&query=households&rows_limit=10",
        "households": [{
                "addressid": "99145446",
                "campaignid": "98716",
                "address_full": "9611 Sundale Jones St, Highlands Ranch CO 80129-6269",
                "address_first_line": "9611 Sundale Jones St",
                "address_second_line": "",
                "address_last_line": "Highlands Ranch CO 80129-6269",
                "city": "Highlands Ranch",
                "state": "CO",
                "zip": "80129",
                "plus4code": "6269",
                "streetname": "Sundale Jones",
                "client_distance": "5.548422149111",
                "devices": [
                    "iPhone"
                ],
                "make_models": [{
                    "year": null,
                    "make": "Chevrolet",
                    "model": "Suburban"
                }],
                                "tags": [
                                      "Google My Business",
                                      "Organic \/ GOOGLE"
                                  ]
            },
            {
                "addressid": "99221583",
                "campaignid": "98716",
                "address_full": "4714 James Brown St, Aurora CO 80015-2111",
                "address_first_line": "4714 James Brown St",
                "address_second_line": "",
                "address_last_line": "Aurora CO 80015-2111",
                "city": "Aurora",
                "state": "CO",
                "zip": "80015",
                "plus4code": "2111",
                "streetname": "James Brown",
                "client_distance": "9.334573865105",
                "devices": [
                    "iPhone"
                ],
                "make_models": [{
                    "year": "2021",
                    "make": "Chevrolet",
                    "model": "Suburban"
                }],
                                "tags": [
                                      "Google My Business",
                                      "Organic \/ GOOGLE"
                                  ]

            },
            {
                "addressid": "99425807",
                "campaignid": "98715",
                "address_full": "132 Northants Ave, Oak Bluffs MA 02557-7144",
                "address_first_line": "132 Northants Ave",
                "address_second_line": "",
                "address_last_line": "Oak Bluffs MA 02557-7144",
                "city": "Oak Bluffs",
                "state": "MA",
                "zip": "2557 ",
                "plus4code": "7144",
                "streetname": "Northants Ave",
                "client_distance": "1799.036746121",
                "devices": [
                    "iPhone"
                ],
                "make_models": [],
                "tags" : []
            }
        ]
    }
}

HTTP Request

***GET*** /influence

Description: Extract a list of Households for a specific Client ID. List can be filtered by Campaign ID, Date, Month and year, and Radius as well as Make/Model and influence tags. There are also pagination options and max record limit options.

Parameters

Name	Located in	Description	Required	Type	Format	Example
clientid	query	ClientID from the clients list query	Yes	integer	digits only	360815
channel	query	CHANNEL_ID from FT Account director	No	integer	digits only	43
from	query	Date from	Yes/No	string	YYYY-mm-dd	2022-01-31
till	query	Date to	Yes/No	string	YYYY-mm-dd	2022-01-01
month	query	Month	Yes/No	integer	2 digit	01
year	query	Year	Yes/No	integer	4 digit	2022
radius	query	Radius from the dealer in miles	No	integer	1-5000	50
page	query	Page	No	integer	1 - maxpage	1
rows_limit	query	Max rows to return in the response	No	integer	10 - 1000	1000
multiunits	query	Include Multiunits	No	char	Y/N/{empty}	Y
model	query	Make/Model filtering	No	text	{Make},{Model} or {Make}	Ram,1500 or Ram
tag	query	Influence tags filtering	No	text or code, see reference	text or code	"Pay Per Click"
ids	query	Households IDS	No	comma separeted integers	{int},{int},...	122244,4577889,222222
Authorization	header		Yes	string

Note : you can use or from/till dates OR month/year , one of these sets is required

Note : to get next 1000 ( or rows_limit ) households you can use {{nextlink}} from the response

**Note : To get list of the codes see Reference below

Responses

Code	Description
200	200 response

Reference

Influence tags reference

Code	Tag
1	Social
4	Digital Media
5	Pay Per Click
6	Referral
7	Email
13	iHeart
17	Other Advertising
31	Google My Business
33	Smart Video
36	Video
1001	Organic / GOOGLE
1002	Organic / BING
1003	Organic / YAHOO
1004	Organic / AOL
1005	Organic / BAIDU
1006	OEM :: JEEP
1007	OEM :: DODGE
1008	OEM :: TOYOTA
1009	OEM :: CHRYSLER
1010	OEM :: ALFA ROMEO
1011	OEM :: FORD
1012	OEM :: LINCOLN
1013	OEM :: GMC
1014	OEM :: LEXUS
1015	OEM :: KIA
1016	OEM :: VOLKSWAGEN
1017	OEM :: HYUNDAI
1018	OEM :: SUBARU
1019	OEM :: AUDI
1020	OEM :: NISSAN
1021	OEM :: FIAT
1022	OEM :: MAZDA
1023	OEM :: BMW
1024	OEM :: ACURA
1025	OEM :: JAGUAR
1026	OEM :: VOLVO
1027	OEM :: MERCEDEZ BENZ
1028	OEM :: HONDA
1029	Referral :: CARGURUS
1030	Referral :: CARS.COM
1031	Referral :: AUTOTRADER
1032	Referral :: CARFAX
1033	Referral :: KBB
1034	Referral :: CARSOUP
1035	Referral :: CARINSIDER
1036	Community / FACEBOOK
1037	Community / INSTAGRAM

Errors

API server returns errors in the body as an associative array example is below

{ "errors": { "003": "Authorization required" } }

Error Code	Meaning
400	Bad Request -- Your request is invalid.
401	Unauthorized -- Your API key is wrong.
403	Forbidden -- The requested is not permitted
404	Not Found -- The specified request url could not be found.
405	Method Not Allowed -- You tried to access a function with an invalid method.
406	Not Acceptable -- You requested an unsupported format
410	Gone -- The requested resource has been removed from our servers.
429	Too Many Requests -- Slow down!
500	Internal Server Error -- We had a problem with our server. Try again later.
503	Service Unavailable -- We're temporarily offline for maintenance. Please try again later.

STEP 4. GO LIVE

Once you have successfully completed STEP 2. REQUEST DATA Testing it is time to Go LIVE !!!

Please reach out to your FT Account director who will provide you with your LIVE APP ID, API KEY, CHANNEL ID and LIVE ENDPOINT URL.