Returns members, and associated profile data, based on criteria specified by parameters, sorted by date of last login. 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
Default date range if none specified is 1 week. The maximum date range - even if a bigger range is specified - is 6 months.
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 |
domain | string |
Filter by the domain the members registered from, without the 'http' or 'www' eg. mydomain.com |
country | string |
ISO 3166-1 alpha-2, comma separated list. eg US,CA,GB |
period | string |
In format of ' ' - eg 2 Month, 1 Day, 3 Week (default: 1 Week) |
period_end | string |
In format of ' ' - eg 2 Month, 1 Day, 3 Week (default: 1 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 |
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 |
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 |
totalmembercount | boolean |
Include the total member count field in API response' |
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
curl -v -X GET "https://api.theappreciationengine.com/v1.1/members/login?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&limit=10"
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.theappreciationengine.com/v1.1/members/login?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/login?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/login?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&limit=10',
'headers': {}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
{
"totalSize": 2,
"items": [
{
"ID": "1111",
"UUID": "11111111-1111-1111-1111-111111111111",
"FirstName": "William",
"Surname": "Riker",
"Username": "ImNumber1",
"Email": "williamriker@starfleet.com",
"Gender": "M",
"Bio": "Guess who's number one...",
"City": null,
"State": null,
"Country": "US",
"Address": null,
"Addressline2": null,
"PostCode": null,
"HomePhone": null,
"MobilePhone": null,
"BrandName": "Wyld Stallyns",
"BrandType": "Artist",
"LastVisited": "2353-04-30 14:35:48",
"Score": "1",
"ActivityCount": "1",
"GeoCity": "",
"GeoRegion": "",
"GeoCountry": "US",
"GeoLat": null,
"GeoLong": null,
"BrandID": "1234",
"MemberAvatarURL": "http://someurl.com",
"LastActivity": {
"ID": "222",
"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": "2353-04-30 14:00:00"
},
"Brand": {
"ID": "1234",
"Name": "Wyld Stallyns",
"Type": "Artist"
},
"CountryCode": "US",
"Services": [
{
"ID": "1111111111",
"Service": "SpotifyAuthenticator",
"Token": "BQAimKCA-duKAUcs6-CxnWBlN7kjqw",
"TokenSecret": "AQDggyhu7yRILTbL-8o5pQH8dtrCobY",
"Valid": "1",
"ActivitySharing": "1",
"UserID": "111",
"Username": "ImNumber1",
"UserURL": "https://open.spotify.com/user/111",
"Expires": "0",
"Followers": "1",
"Likes": "1",
"VerifiedEmail": "williamriker@starfleet.com",
"Domains": [
"http://www.someurl.com",
"https://starfleet.com"
],
"PaidAccount": "1",
"LastUpdated": "2353-04-30 14:00:00",
"LastLogin": "2353-04-30 14:00:00"
}
],
"OptIns": null,
"VerifiedEmail": "williamriker@starfleet.com"
},
{
// 2nd member
}
],
"paging": []
}