Members - Extended



Endpoint

GET /v1.1/members/extended

Description

Returns members, associated profile data AND extended profile data based on criteria specified by parameters. Can also specify fields in Extended node. (eg. Extended.lastUpdated)

Results can be paged by passing offset and limit values to the limit parameter as [offset],[limit]. eg. 10,10 

Parameters
required *

apiKey *  string Your API access key
services  string Comma separated list – eg. twitter, facebook, lastfm, rdio, youtube, custom, etc
fields  string Comma separated list to reduce returned data set to – eg. Email, FirstName, BirthDate
required_fields  string Comma separated list of fields that must have been provided – eg. Email, FirstName, BirthDate
query_extended  string Query Extended data node using dot syntax. Multiple checks can be applied by using 'and'. eg. query_extended=domains.domain=www.somewhere.com and ae_data.lastUpdate > 2015-07-11
order_by  string Specify field in Extended node (eg. extended.lastUpdated).
sort  string Sort direction to apply 'order_by' value. ASC or DESC
members  string Only include these members, comma separated list of native IDs – eg. 811566,803186
emails  string Only include these members by email, comma separated list – eg. abc@here.com,def@there.com
exclude_members  string Ignore these members, comma separated list of native IDs – eg. 811566,803186
paid_only  boolean Filter to users who have a paid service attached eg. Spotify Premium
optedin  boolean Filter to users who have opted in. Brand or Segment ID must also be provided
limit  string Limit the results, default 10, max 1000 eg 100 or 10,10 (offset,limit)

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/members/extended?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&limit=10"
$curl = curl_init();

curl_setopt_array($curl, array( 
	CURLOPT_URL => "https://api.theappreciationengine.com/v1.1/members/extended?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&limit=10", 
	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/members/extended?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&limit=10"

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/members/extended?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&limit=10',
	'headers': {}
};
request(options, function (error, response) {
	if (error) throw new Error(error);
	console.log(response.body);
});

Example Response

{
"totalSize": 1,
"items": [
{
"ID": "12345",
"UUID": "11111111-2222-3333-4444-555555555555",
"FirstName": "Beverly",
"Surname": "Crusher",
"Username": "DrCrusherrr",
"Email": "drbeverlycrusher@starfleet.com",
"Gender": "Female",
"Bio": "Fixing people on the Enterprise",
"City": null,
"State": null,
"Country": null,
"Address": null,
"Addressline2": null,
"PostCode": null,
"HomePhone": null,
"MobilePhone": null,
"BrandName": "Wyld Stallyns",
"BrandType": "",
"LastVisited": "2350-04-30 14:00:00",
"Score": "1800",
"ActivityCount": "123",
"GeoCity": "",
"GeoRegion": "",
"GeoCountry": "",
"GeoLat": null,
"GeoLong": null,
"BrandID": "333333",
"MemberAvatarURL": "http://www.someurl.com",
"LastActivity": {
"ID": "4567",
"Name": "Wyld Stallyns Track Heavy Rotation on Spotify",
"ActivityID": "5555",
"Content": "'God gave rock and roll to you' in heavy rotation on Spotify",
"Link": "https://open.spotify.com/track/0C4ejWmOTMv8vuYj85mf8m",
"CompleteDate": "2350-04-30 14:00:00"
},
"Brand": {
"ID": "333333",
"Name": "Wyld Stallyns",
"Type": "Music"
},
"CountryCode": null,
"Extended": {
"aeid": 23456,
"lastLogin": "2350-04-30 14:00:00",
"lastUpdated": "2350-04-30 16:00:00",
"givenName": "Beverly",
"familyName": "Crusher",
"password": null,
"displayName": "DrCrusherrr",
"email": "drbeverlycrusher@starfleet.com",
"primaryAddress": {
"address1": null,
"address2": null,
"city": null,
"mobile": null,
"phone": null,
"zip": null,
"country": null
},
"birthday": "2324-10-13",
"gender": "Female",
"emailVerified": true,
"cellPhone": null,
"bio": "Fixing people on the Enterprise",
"domains": [
{
"domain": "www.someurl.com",
"firstVisit": "2350-03-30 14:00:00",
"lastVisit": "2350-04-30 14:00:00"
}
],
"profiles": [
{
"domain": "spotify.com",
"profile": {
"preferredUsername": "DrCrusherrr",
"profileUrl": "https://open.spotify.com/user/123",
"name": {
"familyName": "Crusher",
"givenName": "Beverly"
}
},
"following": [
{
"identifier": "https://open.spotify.com/artist/02Cz717BTulFiQXUuIXH6n"
},
{
"identifier": "https://open.spotify.com/artist/04gDigrS5kc9YWfZHwBETP"
},
{
"identifier": "https://open.spotify.com/artist/0TF2NxkJZPQoX1H53rEFM1"
}
],
"accessCredentials": {
"accessToken": "asdf1234",
"type": "Spotify",
"uid": "2212121211212",
"clientId": null
},
"identifier": "https://open.spotify.com/user/123",
"paidAccount": "1"
}
],
"uuid": "11111111-2222-3333-4444-555555555555",
"created": "2350-04-30 16:00:00"
},
"Services": [
{
"ID": "666666",
"Service": "SpotifyAuthenticator",
"Token": "aDLzPjnhbgvfcdjbhgvfqw",
"TokenSecret": "WRYasdfasdasdfcdxobY",
"Valid": "1",
"ActivitySharing": "1",
"UserID": "123",
"Username": "DrCrusherrr",
"UserURL": "https://open.spotify.com/user/123",
"Expires": "0",
"Followers": "1",
"Likes": "4",
"VerifiedEmail": "drbeverlycrusher@starfleet.com",
"Domains": [
"http://www.someurl.com",
"https://www.starfleet.com"
],
"PaidAccount": "1",
"LastUpdated": "2350-04-30 14:00:00",
"LastLogin": "2350-04-30 14:00:00"
}
],
"OptIns": null,
"VerifiedEmail": "drbeverlycrusher@starfleet.com"
}
],
"paging": []
}