Members - Show

Endpoint

GET /v1.1/member/[MemberID]

Description

Returns member proﬁle data, including recent actions and brand affinity. Context is provided by passing in additional parameters, such as campaign, time period, etc.

User must be identified by id, verified_email, email or partnerId/partnerCode combination.

Default date range if none specified is 1 week. The maximum date range - even if a bigger range is specified - is 3 months.

Parameters
required *

apiKey *	`string`	Your API access key
[memberid]	`integer`	The ID of the user to be queried. Instead of id you may provide email, verified_email, partnerId&partnerCode or service&username
email	`string`	Email address
verified_email	`string`	A Verified Email address
partnerCode	`string`	Code speciﬁc to partner who may be integrated with AE, eg. 'janrain'
partnerID	`integer`	Internal user id for speciﬁed partner. PartnerID requires partnerCode
period	`string`	In format of '[Amount] [Unit]' - eg 2 Month, 1 Day, 3 Week (default: 1 Week)
period_end	`string`	In format of '[Amount] [Unit]' - 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
refresh	`integer`	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`	Integer value of 1 or greater, determines afﬁnity for preferred brand - requires showbrands
brandID	`integer`	Filter to user actions and score for speciﬁc brand
segment	`integer`	ID of segment to ﬁlter by – determines scores & position
activityID	`integer`	ID of activity to ﬁlter by – determines scores & position
includeOneTime	`boolean`	Default 0, value of 1 will show 1 time actions such as follows, likes
services	`string`	Comma seperated list – eg. twitter, facebook, lastfm, rdio, youtube, custom, etc – determines scores & position
showposition	`integer`	Value of 1 will include the AEPosition ﬁeld in the data result (default 0). Only shows position if less than 1000, otherwise shows '999+'
showbrands	`boolean`	Value of 1 will include the top of brands for this user (default 0). Affected by ﬁltering
showactions	`boolean`	Value of 1 will include the latest actions for this user (default 0). Affected by ﬁltering
anyofactivities	`string`	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	`string`	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	`boolean`	Value of 1 will include Extended data node. Extended data holds any custom data structures specific to your account
limit	`integer`	Limit the results of the activity and brands, default 3, max 1000. Requires showactions or showbrands

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/member/123456?apiKey=0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p"

$curl = curl_init();

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

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

Example Response

{

  "data": {

    "FirstName": "Jean Luc",

    "Surname": "Picard",

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

    "Username": "JLP",

    "Gender": "M",

    "Bio": "Tea, Earl Grey, Hot.",

    "AccessToken": "25d6d677d66b5a45a96ccaee69_1588810794",

    "ID": 1234,

    "AvatarURL": "http://someurl.com",

    "Country": "",

    "City": null,

    "State": null,

    "CountryCode": "",

    "GeoCountry": null,

    "Extended":{

    "aeid":45678765,

    "lastLogin":"2361-01-27 19:00:00",

    "lastUpdated":"2361-01-27 19:00:00",

    "givenName":"",

    "familyName":"",

    "password":"$2y$10$a8akfasdf*&^%$768q92b",

    "displayName":"",

    "email":"captjeanlucpicard@starfleet.com",

    "gender":"M",

    "emailVerified":true,

    "cellPhone":null,

    "domains":[

      {

        "domain":"enterprise.com",

        "firstVisit":"2360-01-27 19:00:00",

        "lastVisit":"2360-12-27 19:00:00" 

      },

      {

        "domain":"starfleet.com",

        "firstVisit":"2350-01-27 19:00:00",

        "lastVisit":"2358-01-27 19:00:00" 

      }

    ],

    "profiles":[

      {

        "domain":"twitter.com",

        "profile":{

          "preferredUsername":"JLP",

          "profileUrl":"https://someurl.com",

          "name":{"familyName":null,"givenName":null} 

        },

        "accessCredentials":{

          "accessToken":"2306730953.3c82f14",

          "type":"Instagram",

          "uid":"12345",

          "clientId":null 

        },

        "identifier":"https://someurl.com",

        "paidAccount":"0" 

      },

      {

        "domain":"facebook.com",

        "profile":{

          "displayName":"JLP",

          "currentLocation":[{"formatted":"Enterprise, In Space" }],

          "languagesSpoken":[{"languageSpoken":"French","id":"54321" }],

          "preferredUsername":"JLP",

          "profileUrl":"https://someurl.com",

        },

        "accessCredentials":{

          "scopes":"",

          "accessToken":"ASDHFKSDJAFKSDFHJSKDFH83943254321",

          "type":"Facebook",

          "uid":"987654321",

          "expires":0,

          "clientId":null 

        },

        "identifier":null,

        "paidAccount":"0" 

      }

    ],

    "uuid":"11111111-2222-3333-4444-555555555555",

    "created":"2350-09-05 20:00:00",

    "ae_data":{

      "brands":[],

      "lastUpdate":"2355-09-06 20:00:00",

      "period":"3 MONTH",

      "brands_extended":[],

      "period_extended":"3 YEAR" 

    }, 

    "VerifiedEmail": "captjeanlucpicard@starfleet.com"

  },

  "optins": [

    {

      "ID": "1234",

      "Type": "Brand",

      "SegmentID": null,

      "Label": null,

      "Name": "Starfleet"

    },

    {

      "ID": "5678",

      "Type": "1701",

      "SegmentID": "Segment",

      "Label": null,

      "Name": "Launching the new Enterprise"

    }

  ],

  "services": [

    {

      "Service": "spotify",

      "Valid": "1",

      "ActivitySharing": "1",

      "ID": "1122",

      "UserID": "1111",

      "Username": "JLP",

      "UserURL": null,

      "Token": "asdf",

      "TokenSecret": "asdfasdf",

      "LastUpdated": null,

      "LastLogin": "2362-05-05 16:00:00",

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

      "PaidAccount": "1",

      "Followers": "0",

      "Likes": "0",

      "PartnerCode": null,

      "PartnerID": null,

      "Domains": [

          "www.starfleet.com"

      ]

    }

  ],

  "jwt": "eyJhbGciOiJSUzI1NiIsInRMEkwYQfFGMx7qCdUaGU1LbDCg1dSFeivdYPTXQPfSIrlepf8"

}