Members - Login Domains



Endpoint

GET /v1.1/member/[MemberID]/domains/logins

Parameters
required *

apiKey *  string Your API access key
[memberid]  integer The ID of the user to be queried. Instead of id you may provide email, verified_email, partnerId&partnerCode or service&username
email  string Email address
verified_email  string A Verified Email address
partnerCode  string Code specific to partner who may be integrated with AE, eg. 'janrain'
partnerID  integer Internal user id for specified partner. PartnerID requires partnerCode
period  string In format of '[Amount] [Unit]' - eg 2 Month, 1 Day, 3 Week
period_end  string In format of '[Amount] [Unit]' - eg 2 Month, 1 Day, 3 Week
start_date  string In format of 'YYYY-MM-DD HH:MM:SS' – start of date range for results
end_date  string In format of 'YYYY-MM-DD HH:MM:SS' – end of date range for results
refresh  integer value of 1 forces the user record to be refreshed on this call. Note: (BETA) this call may take much longer to return, be prepared to handle appropriately. Will only force refresh of custom segments.
threshold  integer Integer value of 1 or greater, determines affinity for preferred brand - requires showbrands
brandID  integer Filter to user actions and score for specific brand
segment  integer ID of segment to filter by – determines scores & position
activityID  integer ID of activity to filter by – determines scores & position
includeOneTime  boolean Default 0, value of 1 will show 1 time actions such as follows, likes
services  string Comma seperated list – eg. twitter, facebook, lastfm, rdio, youtube, custom, etc – determines scores & position
showposition  integer Value of 1 will include the AEPosition field in the data result (default 0). Only shows position if less than 1000, otherwise shows '999+'
showbrands  boolean Value of 1 will include the top of brands for this user (default 0). Affected by filtering
showactions  boolean Value of 1 will include the latest actions for this user (default 0). Affected by filtering
anyofactivities  string The activity id or ids (comma separated), ANY OF which have been performed by the member. Append brand id in the format brandid-activityid to filter by an activity performed for a specific brand eg. 'Shared a Listen for 5 Seconds of Summer via Facebook' would be 3438697-1350
allofactivities  string The activity id or ids (comma separated), ALL OF which have been performed by each of the member. Append brand id in the format brandid-activityid to filter by an activity performed for a specific brand eg. 'Shared a Listen for 5 Seconds of Summer via Facebook' would be 3438697-1350
extended  boolean Value of 1 will include Extended data node. Extended data holds any custom data structures specific to your account
limit  integer Limit the results of the activity and brands, default 3, max 1000. Requires showactions or showbrands

Sign in with your developer account to use the console, or sign up here

Example Request

curl -v -X GET "https://api.theappreciationengine.com/v1.1/member/123456/domains/logins?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p"
$curl = curl_init();

curl_setopt_array($curl, array( 
	CURLOPT_URL => "https://api.theappreciationengine.com/v1.1/member/123456/domains/logins?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p", 
	CURLOPT_RETURNTRANSFER => true, 
	CURLOPT_ENCODING => "", 
	CURLOPT_MAXREDIRS => 10, 
	CURLOPT_TIMEOUT => 0, 
	CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, 
	CURLOPT_CUSTOMREQUEST => "GET", 
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
import requests

url = "https://api.theappreciationengine.com/v1.1/member/123456/domains/logins?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p"

headers = {}
payload = {}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text.encode('utf8'))
var request = require('request');
var options = {
	'method': 'GET',
	'url': 'https://api.theappreciationengine.com/v1.1/member/123456/domains/logins?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p',
	'headers': {}
};
request(options, function (error, response) {
	if (error) throw new Error(error);
	console.log(response.body);
});

Example Response

{
"registrations": [
{
"domain": "www.someurl.com",
"webpath": "www.someurl.com/campaign/example/",
"segment": "12345",
"visitor": "abcd",
"ip": "1111:222:3333:4444:5555:6666:7777:8888",
"referring_url": "accounts.spotify.com/el/authorize",
"country": "GR",
"memberid": 654321,
"service": "spotify",
"mobile": true,
"device": 1,
"date": "2020-04-23"
},
{
"domain": "www.someurl.com",
"webpath": "www.someurl.com/campaign/example/",
"segment": "12345",
"visitor": "abcd",
"ip": "1111:222:3333:4444:5555:6666:7777:8888",
"referring_url": "accounts.spotify.com/el/authorize",
"country": "GR",
"memberid": 654321,
"service": "spotify",
"mobile": true,
"device": 1,
"date": "2020-04-29"
}
],
"total": 2
}