Members - Top Domains

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

API Version: v1.1

Switch to the API v1.0 documents?

Parameters

apiKey Your API access key
[memberid] The ID of the user to be queried. Instead of id you may provide email, verified_email, partnerId&partnerCode or service&username
email Email address
verified_email A Verified Email address
partnerCode Code specific to partner who may be integrated with AE, eg. 'janrain'
partnerID Internal user id for specified partner. PartnerID requires partnerCode
period Period for actions and top artists returned, in format of ' ' - eg 2 Month, 1 Day, 3 Week
refresh 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 value of 1 or greater, determines affinity for preferred brand - requires showbrands
brandID Filter to user actions and score for specific brand
segment ID of segment to filter by – determines scores & position
activityID ID of activity to filter by – determines scores & position
includeOneTime Default 0, value of 1 will show 1 time actions such as follows, likes
services Comma seperated list – eg. twitter, facebook, lastfm, rdio, youtube, custom, etc – determines scores & position
showposition 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 Value of 1 will include the top of brands for this user (default 0). Affected by filtering
showactions Value of 1 will include the latest actions for this user (default 0). Affected by filtering
anyofactivities 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 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 Value of 1 will include Extended data node. Extended data holds any custom data structures specific to your account
limit Limit the results of the activity and brands, default 3, max 1000. Requires showactions or showbrands

Example Request

				
 					
curl -v -X GET https://api.theappreciationengine.com/v1.1/member/123456/domains/top?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p

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