Members - Active

/v1.1/members/active GET

API Version: v1.1

Switch to the API v1.0 documents?

Description

Returns members, and associated profile data, based on criteria specified by parameters, ordered by the date they were last active. 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

apiKey Your API access key
brandID Filter to user actions and score for specific brand
segmentID ID of the segment to filter by
activityID ID of activity to filter by – not valid when ordered by 'login'
includeOneTime Value of 1 will show one time actions such as follows and likes (default 0)
services Comma separated list – eg. twitter, facebook, lastfm, rdio, youtube, custom, etc
fields Comma separated list to reduce returned data set to – eg. Email, FirstName, BirthDate
required_fields Comma separated list of fields that must have been provided – eg. Email, FirstName, BirthDate
domain Filter by the domain the members registered from, without the 'http' or 'www' eg. mydomain.com
country ISO 3166-1 alpha-2, comma separated list. eg US,CA,GB
region ISO 3166-1 alpha-2, only applicable if a single country is specified
period In format of ' ' - eg 2 Month, 1 Day, 3 Week
period_end In format of ' ' - eg 2 Month, 1 Day, 3 Week
start_date In format of 'yyyy-mm-dd' – start of date range for results
end_date In format of 'yyyy-mm-dd' – end of date range for results
sort Sort direction to apply 'order_by' value. ASC or DESC
members Only include these members, comma separated list of native IDs – eg. 811566,803186
emails Only include these members by email, comma separated list – eg. abc@here.com,def@there.com
anyofactivities 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 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 Ignore these members, comma separated list of native IDs – eg. 811566,803186
paid_only Filter to users who have a paid service attached eg. Spotify Premium
totalmembercount Include the total member count field in API response'
limit Limit the results, default 10, max 1000 eg 100 or 10,10 (offset,limit)

Example Request

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

Sign in with your developer account to use the console, or Sign up for a free 30 day trial