Members - Active


Endpoint

GET /v1.1/members/active

Description

Returns members, and associated profile data, based on criteria specified by parameters, ordered by most active (highest Score) within time range specified. Can be filtered by services, geographic, time period, etc and ordered by 'Score' (default), 'Created' (joined date) or 'LastLogin'. 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.

Parameters
required *

apiKey *  string Your API access key
brandID  integer Filter to user actions and score for specific brand
segmentID  integer ID of the segment to filter by
activityID  integer ID of activity to filter by – not valid when ordered by 'login'
includeOneTime  boolean Value of 1 will show one time actions such as follows and likes (default 0)
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
region  string ISO 3166-1 alpha-2, only applicable if a single country is specified
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
members_from_segment  integer Only include members acquired from this segment (ID)
emails  string Only include these members by email, comma separated list – eg. abc@here.com,def@there.com
anyofactivities  string The activity id or ids (comma separated), ANY OF which have been performed by the members. 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 members. 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
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
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

Example Request

curl -v -X GET "https://api.theappreciationengine.com/v1.1/members/active?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&limit=10"
$curl = curl_init();

curl_setopt_array($curl, array( 
	CURLOPT_URL => "https://api.theappreciationengine.com/v1.1/members/active?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/active?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/active?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p&limit=10',
	'headers': {}
};
request(options, function (error, response) {
	if (error) throw new Error(error);
	console.log(response.body);
});

Example Response

[{

 "totalSize": 2, "items": [ {

 "ID": "12345",

 "UUID": "22222222-3333-4444-5555-666666666666",

 "FirstName": "Deanna",

 "Surname": "Troi",

 "Username": "AreUok",

 "Email": "deannatroi@starfleet.com",

 "Gender": "Female",

 "Bio": "Space counsellor extraordinaire",

 "City": null, "State": null, "Country": null, "Address": null, "Addressline2": null, "PostCode": null, "HomePhone": null, "MobilePhone": null, "BrandName": "Wyld Stallyns",

 "BrandType": "Artist",

 "LastVisited": "2348-04-28 21:00:00",

 "Score": "2500",

 "ActivityCount": "281",

 "GeoCity": "",

 "GeoRegion": "",

 "GeoCountry": "",

 "GeoLat": null, "GeoLong": null, "BrandID": "333333",

 "MemberAvatarURL": "http://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": "2348-04-30 14:00:00" 

}, "Brand": {

 "ID": "333333",

 "Name": "Wyld Stallyns",

 "Type": "Music" 

}, "CountryCode": "",

 "Services": [ {

 "ID": "2345",

 "Service": "SpotifyAuthenticator",

 "Token": "BhjkQCP470UZjMsu-xMEa5OoZzFas6eswhAsyUs4gk3Y",

 "TokenSecret": "AQCcQsYgRo2Iadfgdfsgdsfg7LT0x1qA",

 "Valid": "1",

 "ActivitySharing": "1",

 "UserID": "123",

 "Username": "AreUok",

 "UserURL": "https://open.spotify.com/user/123",

 "Expires": "0",

 "Followers": "11",

 "Likes": "24",

 "VerifiedEmail": "deannatroi@starfleet.com",

 "Domains": [ "www.someurl.com",

 "https://starfleet.com" ], "PaidAccount": "1",

 "LastUpdated": "2348-04-29 20:00:00",

 "LastLogin": "2348-03-21 04:00:00" 

} ], "OptIns": [ {

 "ID": "9999",

 "Type": "Segment",

 "Label": null, "Name": "Listening Events" 

} ], "VerifiedEmail": "deannatroi@starfleet.com" 

},

{

 // 2nd member 

}, ], "paging": {

 "next": "http://theappreciationengine.com/v1.1/members/active?apiKey=yourkey&limit=3&score_lessthan=25&after=25.5",

 "previous": "http://theappreciationengine.com/v1.1/members/active?apiKey=yourkey&limit=3&score_greaterthan=28&before=28.5" 

} 

}]

© Copyright Appreciation Engine Inc 2021, all rights reserved. See our Terms & Conditions, Privacy Policy, Cookie Policy and Privacy Promise.

We are grateful to the lək̓ʷəŋən People of the Esquimalt and Songhees Nations on whose traditional territories Appreciation Engine is based. We also wish to give thanks to the W̱SÁNEĆ, Hul’q’umi’num’, and Snuneymuwx Peoples of the Coast Salish First Nations, and the Ngāti Toa, Muaūpoko, and Ngāti Raukawa ki te Tonga of the Māori iwi, on whose traditional territories the team members of AE work and live.